aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjason2016-11-03 12:32:14 -0600
committerjason2016-11-03 12:32:14 -0600
commit9efcd5a66dc49854841da317fd89c49ed778a669 (patch)
tree7811139e9e0f31ce63531aa3a911331ce4436a5d
parent02002cd2f9b3521f803e992dd4b6cabc9f0aea5d (diff)
downloadeventmq-9efcd5a66dc49854841da317fd89c49ed778a669.tar.gz
eventmq-9efcd5a66dc49854841da317fd89c49ed778a669.zip
update docs
Diffstat
-rw-r--r--_static/basic.css22
-rw-r--r--_static/doctools.js28
-rw-r--r--_static/pygments.css2
-rw-r--r--_static/searchtools.js53
-rw-r--r--_static/websupport.js4
-rw-r--r--api.html9
-rw-r--r--client.html9
-rw-r--r--client/messages.html103
-rw-r--r--contributing.html9
-rw-r--r--exceptions.html11
-rw-r--r--genindex.html29
-rw-r--r--index.html13
-rw-r--r--jobmanager.html21
-rw-r--r--objects.invbin1752 -> 1427 bytes
-rw-r--r--poller.html23
-rw-r--r--protocol.html9
-rw-r--r--py-modindex.html35
-rw-r--r--receiver.html50
-rw-r--r--router.html64
-rw-r--r--search.html5
-rw-r--r--searchindex.js2
-rw-r--r--sender.html53
-rw-r--r--settings_file.html9
-rw-r--r--using.html9
-rw-r--r--utils/classes.html124
-rw-r--r--utils/devices.html11
-rw-r--r--utils/index.html13
-rw-r--r--utils/messages.html33
-rw-r--r--utils/settings.html11
-rw-r--r--utils/timeutils.html13
30 files changed, 345 insertions, 432 deletions
diff --git a/_static/basic.css b/_static/basic.css
index 0b79414..9fa77d8 100644
--- a/_static/basic.css
+++ b/_static/basic.css
@@ -4,7 +4,7 @@
4 * 4 *
5 * Sphinx stylesheet -- basic theme. 5 * Sphinx stylesheet -- basic theme.
6 * 6 *
7 * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. 7 * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
8 * :license: BSD, see LICENSE for details. 8 * :license: BSD, see LICENSE for details.
9 * 9 *
10 */ 10 */
@@ -52,8 +52,6 @@ div.sphinxsidebar {
52 width: 230px; 52 width: 230px;
53 margin-left: -100%; 53 margin-left: -100%;
54 font-size: 90%; 54 font-size: 90%;
55 word-wrap: break-word;
56 overflow-wrap : break-word;
57} 55}
58 56
59div.sphinxsidebar ul { 57div.sphinxsidebar ul {
@@ -85,6 +83,10 @@ div.sphinxsidebar #searchbox input[type="text"] {
85 width: 170px; 83 width: 170px;
86} 84}
87 85
86div.sphinxsidebar #searchbox input[type="submit"] {
87 width: 30px;
88}
89
88img { 90img {
89 border: 0; 91 border: 0;
90 max-width: 100%; 92 max-width: 100%;
@@ -185,13 +187,6 @@ div.genindex-jumpbox {
185 187
186/* -- general body styles --------------------------------------------------- */ 188/* -- general body styles --------------------------------------------------- */
187 189
188div.body p, div.body dd, div.body li, div.body blockquote {
189 -moz-hyphens: auto;
190 -ms-hyphens: auto;
191 -webkit-hyphens: auto;
192 hyphens: auto;
193}
194
195a.headerlink { 190a.headerlink {
196 visibility: hidden; 191 visibility: hidden;
197} 192}
@@ -494,13 +489,6 @@ pre {
494 overflow-y: hidden; /* fixes display issues on Chrome browsers */ 489 overflow-y: hidden; /* fixes display issues on Chrome browsers */
495} 490}
496 491
497span.pre {
498 -moz-hyphens: none;
499 -ms-hyphens: none;
500 -webkit-hyphens: none;
501 hyphens: none;
502}
503
504td.linenos pre { 492td.linenos pre {
505 padding: 5px 0px; 493 padding: 5px 0px;
506 border: 0; 494 border: 0;
diff --git a/_static/doctools.js b/_static/doctools.js
index 8163495..c7bfe76 100644
--- a/_static/doctools.js
+++ b/_static/doctools.js
@@ -4,7 +4,7 @@
4 * 4 *
5 * Sphinx JavaScript utilities for all documentation. 5 * Sphinx JavaScript utilities for all documentation.
6 * 6 *
7 * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. 7 * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
8 * :license: BSD, see LICENSE for details. 8 * :license: BSD, see LICENSE for details.
9 * 9 *
10 */ 10 */
@@ -124,7 +124,6 @@ var Documentation = {
124 this.fixFirefoxAnchorBug(); 124 this.fixFirefoxAnchorBug();
125 this.highlightSearchWords(); 125 this.highlightSearchWords();
126 this.initIndexTable(); 126 this.initIndexTable();
127
128 }, 127 },
129 128
130 /** 129 /**
@@ -253,29 +252,6 @@ var Documentation = {
253 }); 252 });
254 var url = parts.join('/'); 253 var url = parts.join('/');
255 return path.substring(url.lastIndexOf('/') + 1, path.length - 1); 254 return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
256 },
257
258 initOnKeyListeners: function() {
259 $(document).keyup(function(event) {
260 var activeElementType = document.activeElement.tagName;
261 // don't navigate when in search box or textarea
262 if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
263 switch (event.keyCode) {
264 case 37: // left
265 var prevHref = $('link[rel="prev"]').prop('href');
266 if (prevHref) {
267 window.location.href = prevHref;
268 return false;
269 }
270 case 39: // right
271 var nextHref = $('link[rel="next"]').prop('href');
272 if (nextHref) {
273 window.location.href = nextHref;
274 return false;
275 }
276 }
277 }
278 });
279 } 255 }
280}; 256};
281 257
@@ -284,4 +260,4 @@ _ = Documentation.gettext;
284 260
285$(document).ready(function() { 261$(document).ready(function() {
286 Documentation.init(); 262 Documentation.init();
287}); \ No newline at end of file 263});
diff --git a/_static/pygments.css b/_static/pygments.css
index 8213e90..57eadc0 100644
--- a/_static/pygments.css
+++ b/_static/pygments.css
@@ -4,10 +4,8 @@
4.highlight .err { border: 1px solid #FF0000 } /* Error */ 4.highlight .err { border: 1px solid #FF0000 } /* Error */
5.highlight .k { color: #007020; font-weight: bold } /* Keyword */ 5.highlight .k { color: #007020; font-weight: bold } /* Keyword */
6.highlight .o { color: #666666 } /* Operator */ 6.highlight .o { color: #666666 } /* Operator */
7.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
8.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ 7.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
9.highlight .cp { color: #007020 } /* Comment.Preproc */ 8.highlight .cp { color: #007020 } /* Comment.Preproc */
10.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
11.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ 9.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
12.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ 10.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
13.highlight .gd { color: #A00000 } /* Generic.Deleted */ 11.highlight .gd { color: #A00000 } /* Generic.Deleted */
diff --git a/_static/searchtools.js b/_static/searchtools.js
index a51e0dc..0e794fd 100644
--- a/_static/searchtools.js
+++ b/_static/searchtools.js
@@ -2,15 +2,14 @@
2 * searchtools.js_t 2 * searchtools.js_t
3 * ~~~~~~~~~~~~~~~~ 3 * ~~~~~~~~~~~~~~~~
4 * 4 *
5 * Sphinx JavaScript utilities for the full-text search. 5 * Sphinx JavaScript utilties for the full-text search.
6 * 6 *
7 * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. 7 * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
8 * :license: BSD, see LICENSE for details. 8 * :license: BSD, see LICENSE for details.
9 * 9 *
10 */ 10 */
11 11
12 12
13/* Non-minified version JS is _stemmer.js if file is provided */
14/** 13/**
15 * Porter Stemmer 14 * Porter Stemmer
16 */ 15 */
@@ -324,7 +323,7 @@ var Search = {
324 var searchterms = []; 323 var searchterms = [];
325 var excluded = []; 324 var excluded = [];
326 var hlterms = []; 325 var hlterms = [];
327 var tmp = query.split(/\W+/); 326 var tmp = query.split(/\s+/);
328 var objectterms = []; 327 var objectterms = [];
329 for (i = 0; i < tmp.length; i++) { 328 for (i = 0; i < tmp.length; i++) {
330 if (tmp[i] !== "") { 329 if (tmp[i] !== "") {
@@ -374,7 +373,8 @@ var Search = {
374 } 373 }
375 374
376 // lookup as search terms in fulltext 375 // lookup as search terms in fulltext
377 results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms)); 376 results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term))
377 .concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title));
378 378
379 // let the scorer override scores with a custom scoring function 379 // let the scorer override scores with a custom scoring function
380 if (Scorer.score) { 380 if (Scorer.score) {
@@ -538,47 +538,23 @@ var Search = {
538 /** 538 /**
539 * search for full-text terms in the index 539 * search for full-text terms in the index
540 */ 540 */
541 performTermsSearch : function(searchterms, excluded, terms, titleterms) { 541 performTermsSearch : function(searchterms, excluded, terms, score) {
542 var filenames = this._index.filenames; 542 var filenames = this._index.filenames;
543 var titles = this._index.titles; 543 var titles = this._index.titles;
544 544
545 var i, j, file; 545 var i, j, file, files;
546 var fileMap = {}; 546 var fileMap = {};
547 var scoreMap = {};
548 var results = []; 547 var results = [];
549 548
550 // perform the search on the required terms 549 // perform the search on the required terms
551 for (i = 0; i < searchterms.length; i++) { 550 for (i = 0; i < searchterms.length; i++) {
552 var word = searchterms[i]; 551 var word = searchterms[i];
553 var files = [];
554 var _o = [
555 {files: terms[word], score: Scorer.term},
556 {files: titleterms[word], score: Scorer.title}
557 ];
558
559 // no match but word was a required one 552 // no match but word was a required one
560 if ($u.every(_o, function(o){return o.files === undefined;})) { 553 if ((files = terms[word]) === undefined)
561 break; 554 break;
555 if (files.length === undefined) {
556 files = [files];
562 } 557 }
563 // found search word in contents
564 $u.each(_o, function(o) {
565 var _files = o.files;
566 if (_files === undefined)
567 return
568
569 if (_files.length === undefined)
570 _files = [_files];
571 files = files.concat(_files);
572
573 // set score for the word in each file to Scorer.term
574 for (j = 0; j < _files.length; j++) {
575 file = _files[j];
576 if (!(file in scoreMap))
577 scoreMap[file] = {}
578 scoreMap[file][word] = o.score;
579 }
580 });
581
582 // create the mapping 558 // create the mapping
583 for (j = 0; j < files.length; j++) { 559 for (j = 0; j < files.length; j++) {
584 file = files[j]; 560 file = files[j];
@@ -600,9 +576,7 @@ var Search = {
600 // ensure that none of the excluded terms is in the search result 576 // ensure that none of the excluded terms is in the search result
601 for (i = 0; i < excluded.length; i++) { 577 for (i = 0; i < excluded.length; i++) {
602 if (terms[excluded[i]] == file || 578 if (terms[excluded[i]] == file ||
603 titleterms[excluded[i]] == file || 579 $u.contains(terms[excluded[i]] || [], file)) {
604 $u.contains(terms[excluded[i]] || [], file) ||
605 $u.contains(titleterms[excluded[i]] || [], file)) {
606 valid = false; 580 valid = false;
607 break; 581 break;
608 } 582 }
@@ -610,9 +584,6 @@ var Search = {
610 584
611 // if we have still a valid result we can add it to the result list 585 // if we have still a valid result we can add it to the result list
612 if (valid) { 586 if (valid) {
613 // select one (max) score for the file.
614 // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
615 var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
616 results.push([filenames[file], titles[file], '', null, score]); 587 results.push([filenames[file], titles[file], '', null, score]);
617 } 588 }
618 } 589 }
@@ -623,7 +594,7 @@ var Search = {
623 * helper function to return a node containing the 594 * helper function to return a node containing the
624 * search summary for a given text. keywords is a list 595 * search summary for a given text. keywords is a list
625 * of stemmed words, hlwords is the list of normal, unstemmed 596 * of stemmed words, hlwords is the list of normal, unstemmed
626 * words. the first one is used to find the occurrence, the 597 * words. the first one is used to find the occurance, the
627 * latter for highlighting it. 598 * latter for highlighting it.
628 */ 599 */
629 makeSearchSummary : function(text, keywords, hlwords) { 600 makeSearchSummary : function(text, keywords, hlwords) {
diff --git a/_static/websupport.js b/_static/websupport.js
index 98e7f40..28d65db 100644
--- a/_static/websupport.js
+++ b/_static/websupport.js
@@ -2,9 +2,9 @@
2 * websupport.js 2 * websupport.js
3 * ~~~~~~~~~~~~~ 3 * ~~~~~~~~~~~~~
4 * 4 *
5 * sphinx.websupport utilities for all documentation. 5 * sphinx.websupport utilties for all documentation.
6 * 6 *
7 * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. 7 * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
8 * :license: BSD, see LICENSE for details. 8 * :license: BSD, see LICENSE for details.
9 * 9 *
10 */ 10 */
diff --git a/api.html b/api.html
index bfbeb12..dafc27d 100644
--- a/api.html
+++ b/api.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="next" title="client – Client Utilities" href="client.html"/> 34 <link rel="next" title="client – Client Utilities" href="client.html"/>
38 <link rel="prev" title="Settings" href="settings_file.html"/> 35 <link rel="prev" title="Settings" href="settings_file.html"/>
@@ -63,7 +60,7 @@
63 60
64 61
65 <div class="version"> 62 <div class="version">
66 0.2.6.3 63 0.2.6.5
67 </div> 64 </div>
68 65
69 66
@@ -86,7 +83,7 @@
86 83
87 <ul class="current"> 84 <ul class="current">
88<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li> 85<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li>
89<li class="toctree-l1 current"><a class="current reference internal" href="#">API Documentation</a><ul> 86<li class="toctree-l1 current"><a class="current reference internal" href="">API Documentation</a><ul>
90<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li> 87<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li>
91<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> 88<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>
92<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> 89<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>
@@ -120,7 +117,7 @@
120 <div class="rst-content"> 117 <div class="rst-content">
121 118
122 119
123 120
124 121
125 122
126 123
diff --git a/client.html b/client.html
index 4ce61c4..32c60fe 100644
--- a/client.html
+++ b/client.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="up" title="API Documentation" href="api.html"/> 34 <link rel="up" title="API Documentation" href="api.html"/>
38 <link rel="next" title="messages – Client Messaging" href="client/messages.html"/> 35 <link rel="next" title="messages – Client Messaging" href="client/messages.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -88,7 +85,7 @@
88 <ul class="current"> 85 <ul class="current">
89<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li> 86<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li>
90<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> 87<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
91<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a><ul> 88<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a><ul>
92<li class="toctree-l3"><a class="reference internal" href="client/messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Client Messaging</a></li> 89<li class="toctree-l3"><a class="reference internal" href="client/messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Client Messaging</a></li>
93</ul> 90</ul>
94</li> 91</li>
@@ -124,7 +121,7 @@
124 <div class="rst-content"> 121 <div class="rst-content">
125 122
126 123
127 124
128 125
129 126
130 127
diff --git a/client/messages.html b/client/messages.html
index 786c501..6e4b75c 100644
--- a/client/messages.html
+++ b/client/messages.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
37 <link rel="up" title="client – Client Utilities" href="../client.html"/> 34 <link rel="up" title="client – Client Utilities" href="../client.html"/>
38 <link rel="next" title="exceptions – Exceptions" href="../exceptions.html"/> 35 <link rel="next" title="exceptions – Exceptions" href="../exceptions.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -89,7 +86,7 @@
89<li class="toctree-l1"><a class="reference internal" href="../using.html">Using EventMQ</a></li> 86<li class="toctree-l1"><a class="reference internal" href="../using.html">Using EventMQ</a></li>
90<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current"> 87<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current">
91<li class="toctree-l2 current"><a class="reference internal" href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a><ul class="current"> 88<li class="toctree-l2 current"><a class="reference internal" href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a><ul class="current">
92<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Client Messaging</a></li> 89<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Client Messaging</a></li>
93</ul> 90</ul>
94</li> 91</li>
95<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> 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>
@@ -124,7 +121,7 @@
124 <div class="rst-content"> 121 <div class="rst-content">
125 122
126 123
127 124
128 125
129 126
130 127
@@ -158,42 +155,46 @@
158<dd><p>Used to send a job to a worker to execute via <cite>socket</cite>.</p> 155<dd><p>Used to send a job to a worker to execute via <cite>socket</cite>.</p>
159<p>This tries not to raise any exceptions so use some of the message flags to 156<p>This tries not to raise any exceptions so use some of the message flags to
160guarentee things.</p> 157guarentee things.</p>
158<div class="admonition note">
159<p class="first admonition-title">Note</p>
160<p class="last">All passed class &amp; fuction kwargs/args MUST be json serializable.</p>
161</div>
161<table class="docutils field-list" frame="void" rules="none"> 162<table class="docutils field-list" frame="void" rules="none">
162<col class="field-name" /> 163<col class="field-name" />
163<col class="field-body" /> 164<col class="field-body" />
164<tbody valign="top"> 165<tbody valign="top">
165<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 166<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
166<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; eventmq socket to use for sending the message</li> 167<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; eventmq socket to use for sending the message</li>
167<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) &#8211; the callable to be deferred to a worker</li> 168<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) &#8211; the callable to be deferred to a worker</li>
168<li><strong>wrapper</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) &#8211; optional wrapper for the call to func to be 169<li><strong>wrapper</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) &#8211; optional wrapper for the call to func to be
169wrapped with</li> 170wrapped with</li>
170<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id1"><span class="problematic" id="id2">*</span></a>args for the callable</li> 171<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id1"><span class="problematic" id="id2">*</span></a>args for the callable</li>
171<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs for the callable</li> 172<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs for the callable</li>
172<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id5"><span class="problematic" id="id6">*</span></a>args to pass to the the class when 173<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id5"><span class="problematic" id="id6">*</span></a>args to pass to the the class when
173initializing (if applicable).</li> 174initializing (if applicable).</li>
174<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs to pass to the class when 175<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs to pass to the class when
175initializing (if applicable).</li> 176initializing (if applicable).</li>
176<li><strong>reply_requested</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; request the return value of func as a reply</li> 177<li><strong>reply_requested</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; request the return value of func as a reply</li>
177<li><strong>retry_count</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; How many times should be retried when encountering 178<li><strong>retry_count</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; How many times should be retried when encountering
178an Exception or some other failure before giving up. (default: 0 179an Exception or some other failure before giving up. (default: 0
179or immediately fail)</li> 180or immediately fail)</li>
180<li><strong>debounce_secs</strong> (<em>secs</em>) &#8211; Number of seconds to debounce the job. See 181<li><strong>debounce_secs</strong> (<em>secs</em>) &#8211; Number of seconds to debounce the job. See
181<cite>debounce_deferred_job</cite> for more information.</li> 182<cite>debounce_deferred_job</cite> for more information.</li>
182<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of queue to use when executing the job. If this value 183<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of queue to use when executing the job. If this value
183evaluates to False, the default is used. Default: is configured 184evaluates to False, the default is used. Default: is configured
184default queue name</li> 185default queue name</li>
185</ul> 186</ul>
186</td> 187</td>
187</tr> 188</tr>
188<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils"> 189<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code> &#8211;
189<dt>ID for the message/deferred job. This value will be None if there</dt> 190When one or more parameters are not JSON serializable.</p>
190<dd><p class="first last">was an error.</p> 191</td>
191</dd> 192</tr>
192</dl> 193<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID for the message/deferred job. This value will be None if there
193</p> 194was an error.</p>
194</td> 195</td>
195</tr> 196</tr>
196<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p> 197<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></p>
197</td> 198</td>
198</tr> 199</tr>
199</tbody> 200</tbody>
@@ -204,38 +205,42 @@ default queue name</li>
204<dt id="eventmq.client.messages.schedule"> 205<dt id="eventmq.client.messages.schedule">
205<code class="descclassname">eventmq.client.messages.</code><code class="descname">schedule</code><span class="sig-paren">(</span><em>socket</em>, <em>func</em>, <em>interval_secs=None</em>, <em>args=()</em>, <em>kwargs=None</em>, <em>class_args=()</em>, <em>class_kwargs=None</em>, <em>headers=('guarantee'</em>, <em>)</em>, <em>queue='default'</em>, <em>unschedule=False</em>, <em>cron=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.schedule" title="Permalink to this definition">¶</a></dt> 206<code class="descclassname">eventmq.client.messages.</code><code class="descname">schedule</code><span class="sig-paren">(</span><em>socket</em>, <em>func</em>, <em>interval_secs=None</em>, <em>args=()</em>, <em>kwargs=None</em>, <em>class_args=()</em>, <em>class_kwargs=None</em>, <em>headers=('guarantee'</em>, <em>)</em>, <em>queue='default'</em>, <em>unschedule=False</em>, <em>cron=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.schedule" title="Permalink to this definition">¶</a></dt>
206<dd><p>Execute a task on a defined interval.</p> 207<dd><p>Execute a task on a defined interval.</p>
208<div class="admonition note">
209<p class="first admonition-title">Note</p>
210<p class="last">All passed class &amp; fuction kwargs/args MUST be json serializable.</p>
211</div>
207<table class="docutils field-list" frame="void" rules="none"> 212<table class="docutils field-list" frame="void" rules="none">
208<col class="field-name" /> 213<col class="field-name" />
209<col class="field-body" /> 214<col class="field-body" />
210<tbody valign="top"> 215<tbody valign="top">
211<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 216<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
212<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; eventmq socket to use for sending the message</li> 217<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; eventmq socket to use for sending the message</li>
213<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) &#8211; the callable to be scheduled on a worker</li> 218<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) &#8211; the callable to be scheduled on a worker</li>
214<li><strong>minutes</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; minutes to wait in between executions</li> 219<li><strong>minutes</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; minutes to wait in between executions</li>
215<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id9"><span class="problematic" id="id10">*</span></a>args to pass to the callable</li> 220<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id9"><span class="problematic" id="id10">*</span></a>args to pass to the callable</li>
216<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Run job every interval_secs or None if using cron</li> 221<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Run job every interval_secs or None if using cron</li>
217<li><strong>cron</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) &#8211; cron formatted string used for job schedule if 222<li><strong>cron</strong> (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) &#8211; cron formatted string used for job schedule if
218interval_secs is None, i.e. &#8216;* * * * <a href="#id11"><span class="problematic" id="id12">*</span></a>&#8216; (every minute)</li> 223interval_secs is None, i.e. &#8216;* * * * <a href="#id11"><span class="problematic" id="id12">*</span></a>&#8216; (every minute)</li>
219<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id13"><span class="problematic" id="id14">**</span></a>kwargs to pass to the callable</li> 224<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id13"><span class="problematic" id="id14">**</span></a>kwargs to pass to the callable</li>
220<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id15"><span class="problematic" id="id16">*</span></a>args to pass to the class (if applicable)</li> 225<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id15"><span class="problematic" id="id16">*</span></a>args to pass to the class (if applicable)</li>
221<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id17"><span class="problematic" id="id18">**</span></a>kwargs to pass to the class (if 226<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id17"><span class="problematic" id="id18">**</span></a>kwargs to pass to the class (if
222applicable)</li> 227applicable)</li>
223<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of strings denoting enabled headers. Default: 228<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of strings denoting enabled headers. Default:
224guarantee is enabled to ensure the scheduler schedules the job.</li> 229guarantee is enabled to ensure the scheduler schedules the job.</li>
225<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of the queue to use when executing the job. The 230<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of the queue to use when executing the job. The
226default value is the default queue.</li> 231default value is the default queue.</li>
227</ul> 232</ul>
228</td> 233</td>
229</tr> 234</tr>
230<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils"> 235<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code> &#8211;
231<dt>ID of the schedule message that was sent. None if there was an</dt> 236When one or more parameters are not JSON serializable.</p>
232<dd><p class="first last">error</p> 237</td>
233</dd> 238</tr>
234</dl> 239<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the schedule message that was sent. None if there was an
235</p> 240error</p>
236</td> 241</td>
237</tr> 242</tr>
238<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p> 243<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></p>
239</td> 244</td>
240</tr> 245</tr>
241</tbody> 246</tbody>
@@ -281,10 +286,10 @@ the headers then they have been enabled.</p>
281<col class="field-body" /> 286<col class="field-body" />
282<tbody valign="top"> 287<tbody valign="top">
283<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 288<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
284<li><strong>retry_count</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; How many times should be retried when encountering 289<li><strong>retry_count</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; How many times should be retried when encountering
285an Exception or some other failure before giving up. (default: 0 290an Exception or some other failure before giving up. (default: 0
286or immediatly fail)</li> 291or immediatly fail)</li>
287<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of queue to use when executing the job. Default: is 292<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of queue to use when executing the job. Default: is
288configured default queue name</li> 293configured default queue name</li>
289</ul> 294</ul>
290</td> 295</td>
@@ -292,7 +297,7 @@ configured default queue name</li>
292<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> 297<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p>
293</td> 298</td>
294</tr> 299</tr>
295<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p> 300<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></p>
296</td> 301</td>
297</tr> 302</tr>
298</tbody> 303</tbody>
@@ -310,18 +315,18 @@ interval for the scheduler.</p>
310<col class="field-body" /> 315<col class="field-body" />
311<tbody valign="top"> 316<tbody valign="top">
312<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 317<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
313<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; </li> 318<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; </li>
314<li><strong>job_schedule</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; </li> 319<li><strong>(str)</strong> (<em>job_schedule</em>) &#8211; </li>
315<li><strong>message</strong> &#8211; Message to send socket.</li> 320<li><strong>message</strong> &#8211; Message to send socket.</li>
316<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; List of headers for the message</li> 321<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; List of headers for the message</li>
317<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of queue the job should be executed in</li> 322<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of queue the job should be executed in</li>
318</ul> 323</ul>
319</td> 324</td>
320</tr> 325</tr>
321<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> 326<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p>
322</td> 327</td>
323</tr> 328</tr>
324<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p> 329<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></p>
325</td> 330</td>
326</tr> 331</tr>
327</tbody> 332</tbody>
diff --git a/contributing.html b/contributing.html
index 7654b29..8d107f7 100644
--- a/contributing.html
+++ b/contributing.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="next" title="EventMQ Protocol Specification" href="protocol.html"/> 34 <link rel="next" title="EventMQ Protocol Specification" href="protocol.html"/>
38 <link rel="prev" title="timeutils – Time Utilites" href="utils/timeutils.html"/> 35 <link rel="prev" title="timeutils – Time Utilites" href="utils/timeutils.html"/>
@@ -63,7 +60,7 @@
63 60
64 61
65 <div class="version"> 62 <div class="version">
66 0.2.6.3 63 0.2.6.5
67 </div> 64 </div>
68 65
69 66
@@ -87,7 +84,7 @@
87 <ul class="current"> 84 <ul class="current">
88<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li> 85<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li>
89<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li> 86<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li>
90<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to EventMQ</a><ul> 87<li class="toctree-l1 current"><a class="current reference internal" href="">Contributing to EventMQ</a><ul>
91<li class="toctree-l2"><a class="reference internal" href="protocol.html">EventMQ Protocol Specification</a></li> 88<li class="toctree-l2"><a class="reference internal" href="protocol.html">EventMQ Protocol Specification</a></li>
92<li class="toctree-l2"><a class="reference external" href="https://github.com/enderlabs/eventmq">Source Code</a></li> 89<li class="toctree-l2"><a class="reference external" href="https://github.com/enderlabs/eventmq">Source Code</a></li>
93<li class="toctree-l2"><a class="reference external" href="https://github.com/enderlabs/eventmq/issues">Issues</a></li> 90<li class="toctree-l2"><a class="reference external" href="https://github.com/enderlabs/eventmq/issues">Issues</a></li>
@@ -115,7 +112,7 @@
115 <div class="rst-content"> 112 <div class="rst-content">
116 113
117 114
118 115
119 116
120 117
121 118
diff --git a/exceptions.html b/exceptions.html
index 4b6baae..98debb3 100644
--- a/exceptions.html
+++ b/exceptions.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="up" title="API Documentation" href="api.html"/> 34 <link rel="up" title="API Documentation" href="api.html"/>
38 <link rel="next" title="jobmanager – Job Manager" href="jobmanager.html"/> 35 <link rel="next" title="jobmanager – Job Manager" href="jobmanager.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -89,7 +86,7 @@
89<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li> 86<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li>
90<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> 87<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
91<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li> 88<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li>
92<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li> 89<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li>
93<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> 90<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>
94<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li> 91<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li>
95<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> 92<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>
@@ -121,7 +118,7 @@
121 <div class="rst-content"> 118 <div class="rst-content">
122 119
123 120
124 121
125 122
126 123
127 124
@@ -146,7 +143,7 @@
146 <div itemprop="articleBody"> 143 <div itemprop="articleBody">
147 144
148 <span class="target" id="module-eventmq.exceptions"></span><div class="section" id="exceptions-exceptions"> 145 <span class="target" id="module-eventmq.exceptions"></span><div class="section" id="exceptions-exceptions">
149<h1><a class="reference external" href="https://docs.python.org/2/library/exceptions.html#module-exceptions" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">exceptions</span></code></a> &#8211; Exceptions<a class="headerlink" href="#exceptions-exceptions" title="Permalink to this headline">¶</a></h1> 146<h1><a class="reference external" href="https://docs.python.org/library/exceptions.html#module-exceptions" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">exceptions</span></code></a> &#8211; Exceptions<a class="headerlink" href="#exceptions-exceptions" title="Permalink to this headline">¶</a></h1>
150<p>These are the exceptions that are raised by EventMQ. All exceptions should 147<p>These are the exceptions that are raised by EventMQ. All exceptions should
151be subclasses of <a class="reference internal" href="#eventmq.exceptions.EventMQError" title="eventmq.exceptions.EventMQError"><code class="xref py py-class docutils literal"><span class="pre">EventMQError</span></code></a></p> 148be subclasses of <a class="reference internal" href="#eventmq.exceptions.EventMQError" title="eventmq.exceptions.EventMQError"><code class="xref py py-class docutils literal"><span class="pre">EventMQError</span></code></a></p>
152<dl class="exception"> 149<dl class="exception">
diff --git a/genindex.html b/genindex.html
index 070a070..9eadd75 100644
--- a/genindex.html
+++ b/genindex.html
@@ -31,9 +31,6 @@
31 31
32 32
33 33
34 <link rel="index" title="Index"
35 href="#"/>
36 <link rel="search" title="Search" href="search.html"/>
37 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 34 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
38 35
39 36
@@ -62,7 +59,7 @@
62 59
63 60
64 <div class="version"> 61 <div class="version">
65 0.2.6.3 62 0.2.6.5
66 </div> 63 </div>
67 64
68 65
@@ -460,12 +457,12 @@
460 <dt><a href="router.html#eventmq.router.Router.job_latencies">job_latencies (eventmq.router.Router attribute)</a> 457 <dt><a href="router.html#eventmq.router.Router.job_latencies">job_latencies (eventmq.router.Router attribute)</a>
461 </dt> 458 </dt>
462 459
463 </dl></td>
464 <td style="width: 33%" valign="top"><dl>
465 460
466 <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager">JobManager (class in eventmq.jobmanager)</a> 461 <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager">JobManager (class in eventmq.jobmanager)</a>
467 </dt> 462 </dt>
468 463
464 </dl></td>
465 <td style="width: 33%" valign="top"><dl>
469 466
470 <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager.jobmanager_main">jobmanager_main() (eventmq.jobmanager.JobManager method)</a> 467 <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager.jobmanager_main">jobmanager_main() (eventmq.jobmanager.JobManager method)</a>
471 </dt> 468 </dt>
@@ -496,12 +493,12 @@
496 <dt><a href="exceptions.html#eventmq.exceptions.MessageError">MessageError</a> 493 <dt><a href="exceptions.html#eventmq.exceptions.MessageError">MessageError</a>
497 </dt> 494 </dt>
498 495
499 </dl></td>
500 <td style="width: 33%" valign="top"><dl>
501 496
502 <dt><a href="utils/timeutils.html#eventmq.utils.timeutils.monotonic">monotonic() (in module eventmq.utils.timeutils)</a> 497 <dt><a href="utils/timeutils.html#eventmq.utils.timeutils.monotonic">monotonic() (in module eventmq.utils.timeutils)</a>
503 </dt> 498 </dt>
504 499
500 </dl></td>
501 <td style="width: 33%" valign="top"><dl>
505 502
506 <dt><a href="jobmanager.html#eventmq.jobmanager.mp_init">mp_init() (in module eventmq.jobmanager)</a> 503 <dt><a href="jobmanager.html#eventmq.jobmanager.mp_init">mp_init() (in module eventmq.jobmanager)</a>
507 </dt> 504 </dt>
@@ -599,6 +596,14 @@
599 </dt> 596 </dt>
600 597
601 598
599 <dt><a href="utils/classes.html#eventmq.utils.classes.EMQdeque.peek">peek() (eventmq.utils.classes.EMQdeque method)</a>
600 </dt>
601
602
603 <dt><a href="utils/classes.html#eventmq.utils.classes.EMQdeque.peekleft">peekleft() (eventmq.utils.classes.EMQdeque method)</a>
604 </dt>
605
606
602 <dt><a href="exceptions.html#eventmq.exceptions.PeerGoneAwayError">PeerGoneAwayError</a> 607 <dt><a href="exceptions.html#eventmq.exceptions.PeerGoneAwayError">PeerGoneAwayError</a>
603 </dt> 608 </dt>
604 609
@@ -860,12 +865,12 @@
860 </dt> 865 </dt>
861 866
862 </dl></dd> 867 </dl></dd>
863 </dl></td>
864 <td style="width: 33%" valign="top"><dl>
865 868
866 <dt><a href="exceptions.html#eventmq.exceptions.UnknownQueueError">UnknownQueueError</a> 869 <dt><a href="exceptions.html#eventmq.exceptions.UnknownQueueError">UnknownQueueError</a>
867 </dt> 870 </dt>
868 871
872 </dl></td>
873 <td style="width: 33%" valign="top"><dl>
869 874
870 <dt><a href="poller.html#eventmq.poller.Poller.unregister">unregister() (eventmq.poller.Poller method)</a> 875 <dt><a href="poller.html#eventmq.poller.Poller.unregister">unregister() (eventmq.poller.Poller method)</a>
871 </dt> 876 </dt>
@@ -906,12 +911,12 @@
906 <dt><a href="utils/index.html#eventmq.utils.zero_index_cmp">zero_index_cmp() (in module eventmq.utils)</a> 911 <dt><a href="utils/index.html#eventmq.utils.zero_index_cmp">zero_index_cmp() (in module eventmq.utils)</a>
907 </dt> 912 </dt>
908 913
909 </dl></td>
910 <td style="width: 33%" valign="top"><dl>
911 914
912 <dt><a href="utils/classes.html#eventmq.utils.classes.ZMQReceiveMixin">ZMQReceiveMixin (class in eventmq.utils.classes)</a> 915 <dt><a href="utils/classes.html#eventmq.utils.classes.ZMQReceiveMixin">ZMQReceiveMixin (class in eventmq.utils.classes)</a>
913 </dt> 916 </dt>
914 917
918 </dl></td>
919 <td style="width: 33%" valign="top"><dl>
915 920
916 <dt><a href="utils/classes.html#eventmq.utils.classes.ZMQSendMixin">ZMQSendMixin (class in eventmq.utils.classes)</a> 921 <dt><a href="utils/classes.html#eventmq.utils.classes.ZMQSendMixin">ZMQSendMixin (class in eventmq.utils.classes)</a>
917 </dt> 922 </dt>
diff --git a/index.html b/index.html
index 3055ab1..263129e 100644
--- a/index.html
+++ b/index.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="#"/> 33 <link rel="top" title="EventMQ 0 documentation" href="#"/>
37 <link rel="next" title="Using EventMQ" href="using.html"/> 34 <link rel="next" title="Using EventMQ" href="using.html"/>
38 35
@@ -62,7 +59,7 @@
62 59
63 60
64 <div class="version"> 61 <div class="version">
65 0.2.6.3 62 0.2.6.5
66 </div> 63 </div>
67 64
68 65
@@ -109,7 +106,7 @@
109 <div class="rst-content"> 106 <div class="rst-content">
110 107
111 108
112 109
113 110
114 111
115 112
@@ -161,9 +158,9 @@
161<div class="section" id="indices-and-tables"> 158<div class="section" id="indices-and-tables">
162<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2> 159<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
163<ul class="simple"> 160<ul class="simple">
164<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li> 161<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li>
165<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li> 162<li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li>
166<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li> 163<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li>
167</ul> 164</ul>
168</div> 165</div>
169</div> 166</div>
diff --git a/jobmanager.html b/jobmanager.html
index d962271..349530e 100644
--- a/jobmanager.html
+++ b/jobmanager.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="up" title="API Documentation" href="api.html"/> 34 <link rel="up" title="API Documentation" href="api.html"/>
38 <link rel="next" title="poller – Poller" href="poller.html"/> 35 <link rel="next" title="poller – Poller" href="poller.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -90,7 +87,7 @@
90<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> 87<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
91<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li> 88<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client 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> 89<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>
93<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 90<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li>
94<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li> 91<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li>
95<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> 92<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>
96<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> 93<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>
@@ -121,7 +118,7 @@
121 <div class="rst-content"> 118 <div class="rst-content">
122 119
123 120
124 121
125 122
126 123
127 124
@@ -166,10 +163,10 @@ to manage the resources on the server it&#8217;s running.</p>
166<col class="field-body" /> 163<col class="field-body" />
167<tbody valign="top"> 164<tbody valign="top">
168<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 165<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
169<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; unique name of this instance. By default a uuid will be 166<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; unique name of this instance. By default a uuid will be
170generated.</li> 167generated.</li>
171<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; List of queue names to listen on.</li> 168<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; List of queue names to listen on.</li>
172<li><strong>skip_signal</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; Don&#8217;t register the signal handlers. Useful for 169<li><strong>skip_signal</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; Don&#8217;t register the signal handlers. Useful for
173testing.</li> 170testing.</li>
174</ul> 171</ul>
175</td> 172</td>
@@ -192,7 +189,7 @@ testing.</li>
192<col class="field-name" /> 189<col class="field-name" />
193<col class="field-body" /> 190<col class="field-body" />
194<tbody valign="top"> 191<tbody valign="top">
195<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The address of the broker to connect to.</td> 192<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The address of the broker to connect to.</td>
196</tr> 193</tr>
197</tbody> 194</tbody>
198</table> 195</table>
@@ -275,8 +272,8 @@ for another REQUEST message.</p>
275<col class="field-body" /> 272<col class="field-body" />
276<tbody valign="top"> 273<tbody valign="top">
277<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 274<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
278<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The socket to use for this ack</li> 275<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The socket to use for this ack</li>
279<li><strong>recipient</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The recipient id for the ack</li> 276<li><strong>recipient</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The recipient id for the ack</li>
280<li><strong>msgid</strong> &#8211; The unique id that we are acknowledging</li> 277<li><strong>msgid</strong> &#8211; The unique id that we are acknowledging</li>
281</ul> 278</ul>
282</td> 279</td>
diff --git a/objects.inv b/objects.inv
index 9b383df..ae3e3c5 100644
--- a/objects.inv
+++ b/objects.inv
Binary files differ
diff --git a/poller.html b/poller.html
index 2e476ea..e194f10 100644
--- a/poller.html
+++ b/poller.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="up" title="API Documentation" href="api.html"/> 34 <link rel="up" title="API Documentation" href="api.html"/>
38 <link rel="next" title="receiver – Receiver" href="receiver.html"/> 35 <link rel="next" title="receiver – Receiver" href="receiver.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -91,7 +88,7 @@
91<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li> 88<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client 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> 89<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>
93<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> 90<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>
94<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li> 91<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li>
95<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> 92<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>
96<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> 93<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>
97<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> 94<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>
@@ -121,7 +118,7 @@
121 <div class="rst-content"> 118 <div class="rst-content">
122 119
123 120
124 121
125 122
126 123
127 124
@@ -151,17 +148,17 @@
151<dl class="class"> 148<dl class="class">
152<dt id="eventmq.poller.Poller"> 149<dt id="eventmq.poller.Poller">
153<em class="property">class </em><code class="descclassname">eventmq.poller.</code><code class="descname">Poller</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller" title="Permalink to this definition">¶</a></dt> 150<em class="property">class </em><code class="descclassname">eventmq.poller.</code><code class="descname">Poller</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller" title="Permalink to this definition">¶</a></dt>
154<dd><p><a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Poller" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Poller</span></code></a> based class.</p> 151<dd><p><a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Poller" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Poller</span></code></a> based class.</p>
155<dl class="method"> 152<dl class="method">
156<dt id="eventmq.poller.Poller.__init__"> 153<dt id="eventmq.poller.Poller.__init__">
157<code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller.__init__" title="Permalink to this definition">¶</a></dt> 154<code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller.__init__" title="Permalink to this definition">¶</a></dt>
158<dd><p>See <a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Poller" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Poller</span></code></a></p> 155<dd><p>See <a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Poller" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Poller</span></code></a></p>
159</dd></dl> 156</dd></dl>
160 157
161<dl class="method"> 158<dl class="method">
162<dt id="eventmq.poller.Poller.poll"> 159<dt id="eventmq.poller.Poller.poll">
163<code class="descname">poll</code><span class="sig-paren">(</span><em>timeout=1</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller.poll" title="Permalink to this definition">¶</a></dt> 160<code class="descname">poll</code><span class="sig-paren">(</span><em>timeout=1</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller.poll" title="Permalink to this definition">¶</a></dt>
164<dd><p>Calling <a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Poller.poll" title="(in PyZMQ v15.0.0)"><code class="xref py py-meth docutils literal"><span class="pre">zmq.Poller.poll()</span></code></a> directly returns a tuple set. This 161<dd><p>Calling <a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Poller.poll" title="(in PyZMQ v15.0.0)"><code class="xref py py-meth docutils literal"><span class="pre">zmq.Poller.poll()</span></code></a> directly returns a tuple set. This
165method typecasts to a dictionary for convience using the socket object 162method typecasts to a dictionary for convience using the socket object
166as the key. If a socket doesn&#8217;t appear in the returned dictionary then 163as the key. If a socket doesn&#8217;t appear in the returned dictionary then
167no events happened.</p> 164no events happened.</p>
@@ -169,7 +166,7 @@ no events happened.</p>
169<col class="field-name" /> 166<col class="field-name" />
170<col class="field-body" /> 167<col class="field-body" />
171<tbody valign="top"> 168<tbody valign="top">
172<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; How long should poller wait for before iterating 169<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; How long should poller wait for before iterating
173the next loop.</td> 170the next loop.</td>
174</tr> 171</tr>
175</tbody> 172</tbody>
@@ -189,8 +186,8 @@ the next loop.</td>
189<col class="field-body" /> 186<col class="field-body" />
190<tbody valign="top"> 187<tbody valign="top">
191<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 188<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
192<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The socket object to register</li> 189<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The socket object to register</li>
193<li><strong>flags</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; <code class="xref py py-attr docutils literal"><span class="pre">POLLIN</span></code>, <code class="xref py py-attr docutils literal"><span class="pre">POLLOUT</span></code>, or 190<li><strong>flags</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; <code class="xref py py-attr docutils literal"><span class="pre">POLLIN</span></code>, <code class="xref py py-attr docutils literal"><span class="pre">POLLOUT</span></code>, or
194<code class="xref py py-attr docutils literal"><span class="pre">POLLIN`|:attr:`POLLOUT</span></code> for both. If undefined the 191<code class="xref py py-attr docutils literal"><span class="pre">POLLIN`|:attr:`POLLOUT</span></code> for both. If undefined the
195socket remains unregistered.</li> 192socket remains unregistered.</li>
196</ul> 193</ul>
@@ -208,7 +205,7 @@ socket remains unregistered.</li>
208<col class="field-name" /> 205<col class="field-name" />
209<col class="field-body" /> 206<col class="field-body" />
210<tbody valign="top"> 207<tbody valign="top">
211<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The socket object to registering</td> 208<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The socket object to registering</td>
212</tr> 209</tr>
213</tbody> 210</tbody>
214</table> 211</table>
diff --git a/protocol.html b/protocol.html
index 876d1c1..92e084d 100644
--- a/protocol.html
+++ b/protocol.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="up" title="Contributing to EventMQ" href="contributing.html"/> 34 <link rel="up" title="Contributing to EventMQ" href="contributing.html"/>
38 <link rel="prev" title="Contributing to EventMQ" href="contributing.html"/> 35 <link rel="prev" title="Contributing to EventMQ" href="contributing.html"/>
@@ -63,7 +60,7 @@
63 60
64 61
65 <div class="version"> 62 <div class="version">
66 0.2.6.3 63 0.2.6.5
67 </div> 64 </div>
68 65
69 66
@@ -88,7 +85,7 @@
88<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li> 85<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li>
89<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li> 86<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li>
90<li class="toctree-l1 current"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a><ul class="current"> 87<li class="toctree-l1 current"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a><ul class="current">
91<li class="toctree-l2 current"><a class="current reference internal" href="#">EventMQ Protocol Specification</a><ul> 88<li class="toctree-l2 current"><a class="current reference internal" href="">EventMQ Protocol Specification</a><ul>
92<li class="toctree-l3"><a class="reference internal" href="#goals">Goals</a></li> 89<li class="toctree-l3"><a class="reference internal" href="#goals">Goals</a></li>
93<li class="toctree-l3"><a class="reference internal" href="#license">License</a></li> 90<li class="toctree-l3"><a class="reference internal" href="#license">License</a></li>
94<li class="toctree-l3"><a class="reference internal" href="#language">Language</a></li> 91<li class="toctree-l3"><a class="reference internal" href="#language">Language</a></li>
@@ -132,7 +129,7 @@
132 <div class="rst-content"> 129 <div class="rst-content">
133 130
134 131
135 132
136 133
137 134
138 135
diff --git a/py-modindex.html b/py-modindex.html
index c9b583e..b0fadf1 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 34
38 35
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -139,7 +136,7 @@
139 </div> 136 </div>
140 137
141 <table class="indextable modindextable" cellspacing="0" cellpadding="2"> 138 <table class="indextable modindextable" cellspacing="0" cellpadding="2">
142 <tr class="pcap"><td></td><td>&#160;</td><td></td></tr> 139 <tr class="pcap"><td></td><td>&nbsp;</td><td></td></tr>
143 <tr class="cap" id="cap-e"><td></td><td> 140 <tr class="cap" id="cap-e"><td></td><td>
144 <strong>e</strong></td><td></td></tr> 141 <strong>e</strong></td><td></td></tr>
145 <tr> 142 <tr>
@@ -150,72 +147,72 @@
150 <em></em></td></tr> 147 <em></em></td></tr>
151 <tr class="cg-1"> 148 <tr class="cg-1">
152 <td></td> 149 <td></td>
153 <td>&#160;&#160;&#160; 150 <td>&nbsp;&nbsp;&nbsp;
154 <a href="client.html#module-eventmq.client"><code class="xref">eventmq.client</code></a></td><td> 151 <a href="client.html#module-eventmq.client"><code class="xref">eventmq.client</code></a></td><td>
155 <em></em></td></tr> 152 <em></em></td></tr>
156 <tr class="cg-1"> 153 <tr class="cg-1">
157 <td></td> 154 <td></td>
158 <td>&#160;&#160;&#160; 155 <td>&nbsp;&nbsp;&nbsp;
159 <a href="client/messages.html#module-eventmq.client.messages"><code class="xref">eventmq.client.messages</code></a></td><td> 156 <a href="client/messages.html#module-eventmq.client.messages"><code class="xref">eventmq.client.messages</code></a></td><td>
160 <em></em></td></tr> 157 <em></em></td></tr>
161 <tr class="cg-1"> 158 <tr class="cg-1">
162 <td></td> 159 <td></td>
163 <td>&#160;&#160;&#160; 160 <td>&nbsp;&nbsp;&nbsp;
164 <a href="exceptions.html#module-eventmq.exceptions"><code class="xref">eventmq.exceptions</code></a></td><td> 161 <a href="exceptions.html#module-eventmq.exceptions"><code class="xref">eventmq.exceptions</code></a></td><td>
165 <em></em></td></tr> 162 <em></em></td></tr>
166 <tr class="cg-1"> 163 <tr class="cg-1">
167 <td></td> 164 <td></td>
168 <td>&#160;&#160;&#160; 165 <td>&nbsp;&nbsp;&nbsp;
169 <a href="jobmanager.html#module-eventmq.jobmanager"><code class="xref">eventmq.jobmanager</code></a></td><td> 166 <a href="jobmanager.html#module-eventmq.jobmanager"><code class="xref">eventmq.jobmanager</code></a></td><td>
170 <em></em></td></tr> 167 <em></em></td></tr>
171 <tr class="cg-1"> 168 <tr class="cg-1">
172 <td></td> 169 <td></td>
173 <td>&#160;&#160;&#160; 170 <td>&nbsp;&nbsp;&nbsp;
174 <a href="poller.html#module-eventmq.poller"><code class="xref">eventmq.poller</code></a></td><td> 171 <a href="poller.html#module-eventmq.poller"><code class="xref">eventmq.poller</code></a></td><td>
175 <em></em></td></tr> 172 <em></em></td></tr>
176 <tr class="cg-1"> 173 <tr class="cg-1">
177 <td></td> 174 <td></td>
178 <td>&#160;&#160;&#160; 175 <td>&nbsp;&nbsp;&nbsp;
179 <a href="receiver.html#module-eventmq.receiver"><code class="xref">eventmq.receiver</code></a></td><td> 176 <a href="receiver.html#module-eventmq.receiver"><code class="xref">eventmq.receiver</code></a></td><td>
180 <em></em></td></tr> 177 <em></em></td></tr>
181 <tr class="cg-1"> 178 <tr class="cg-1">
182 <td></td> 179 <td></td>
183 <td>&#160;&#160;&#160; 180 <td>&nbsp;&nbsp;&nbsp;
184 <a href="router.html#module-eventmq.router"><code class="xref">eventmq.router</code></a></td><td> 181 <a href="router.html#module-eventmq.router"><code class="xref">eventmq.router</code></a></td><td>
185 <em></em></td></tr> 182 <em></em></td></tr>
186 <tr class="cg-1"> 183 <tr class="cg-1">
187 <td></td> 184 <td></td>
188 <td>&#160;&#160;&#160; 185 <td>&nbsp;&nbsp;&nbsp;
189 <a href="sender.html#module-eventmq.sender"><code class="xref">eventmq.sender</code></a></td><td> 186 <a href="sender.html#module-eventmq.sender"><code class="xref">eventmq.sender</code></a></td><td>
190 <em></em></td></tr> 187 <em></em></td></tr>
191 <tr class="cg-1"> 188 <tr class="cg-1">
192 <td></td> 189 <td></td>
193 <td>&#160;&#160;&#160; 190 <td>&nbsp;&nbsp;&nbsp;
194 <a href="utils/index.html#module-eventmq.utils"><code class="xref">eventmq.utils</code></a></td><td> 191 <a href="utils/index.html#module-eventmq.utils"><code class="xref">eventmq.utils</code></a></td><td>
195 <em></em></td></tr> 192 <em></em></td></tr>
196 <tr class="cg-1"> 193 <tr class="cg-1">
197 <td></td> 194 <td></td>
198 <td>&#160;&#160;&#160; 195 <td>&nbsp;&nbsp;&nbsp;
199 <a href="utils/classes.html#module-eventmq.utils.classes"><code class="xref">eventmq.utils.classes</code></a></td><td> 196 <a href="utils/classes.html#module-eventmq.utils.classes"><code class="xref">eventmq.utils.classes</code></a></td><td>
200 <em></em></td></tr> 197 <em></em></td></tr>
201 <tr class="cg-1"> 198 <tr class="cg-1">
202 <td></td> 199 <td></td>
203 <td>&#160;&#160;&#160; 200 <td>&nbsp;&nbsp;&nbsp;
204 <a href="utils/devices.html#module-eventmq.utils.devices"><code class="xref">eventmq.utils.devices</code></a></td><td> 201 <a href="utils/devices.html#module-eventmq.utils.devices"><code class="xref">eventmq.utils.devices</code></a></td><td>
205 <em></em></td></tr> 202 <em></em></td></tr>
206 <tr class="cg-1"> 203 <tr class="cg-1">
207 <td></td> 204 <td></td>
208 <td>&#160;&#160;&#160; 205 <td>&nbsp;&nbsp;&nbsp;
209 <a href="utils/messages.html#module-eventmq.utils.messages"><code class="xref">eventmq.utils.messages</code></a></td><td> 206 <a href="utils/messages.html#module-eventmq.utils.messages"><code class="xref">eventmq.utils.messages</code></a></td><td>
210 <em></em></td></tr> 207 <em></em></td></tr>
211 <tr class="cg-1"> 208 <tr class="cg-1">
212 <td></td> 209 <td></td>
213 <td>&#160;&#160;&#160; 210 <td>&nbsp;&nbsp;&nbsp;
214 <a href="utils/settings.html#module-eventmq.utils.settings"><code class="xref">eventmq.utils.settings</code></a></td><td> 211 <a href="utils/settings.html#module-eventmq.utils.settings"><code class="xref">eventmq.utils.settings</code></a></td><td>
215 <em></em></td></tr> 212 <em></em></td></tr>
216 <tr class="cg-1"> 213 <tr class="cg-1">
217 <td></td> 214 <td></td>
218 <td>&#160;&#160;&#160; 215 <td>&nbsp;&nbsp;&nbsp;
219 <a href="utils/timeutils.html#module-eventmq.utils.timeutils"><code class="xref">eventmq.utils.timeutils</code></a></td><td> 216 <a href="utils/timeutils.html#module-eventmq.utils.timeutils"><code class="xref">eventmq.utils.timeutils</code></a></td><td>
220 <em></em></td></tr> 217 <em></em></td></tr>
221 </table> 218 </table>
diff --git a/receiver.html b/receiver.html
index 0f45eba..8a5c973 100644
--- a/receiver.html
+++ b/receiver.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="up" title="API Documentation" href="api.html"/> 34 <link rel="up" title="API Documentation" href="api.html"/>
38 <link rel="next" title="router – Router" href="router.html"/> 35 <link rel="next" title="router – Router" href="router.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -92,7 +89,7 @@
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> 89<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>
93<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> 90<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>
94<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li> 91<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li>
95<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> 92<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>
96<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> 93<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>
97<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> 94<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>
98<li class="toctree-l2"><a class="reference internal" href="utils/index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li> 95<li class="toctree-l2"><a class="reference internal" href="utils/index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
@@ -121,7 +118,7 @@
121 <div class="rst-content"> 118 <div class="rst-content">
122 119
123 120
124 121
125 122
126 123
127 124
@@ -155,19 +152,21 @@
155<dl class="attribute"> 152<dl class="attribute">
156<dt id="eventmq.receiver.Receiver.name"> 153<dt id="eventmq.receiver.Receiver.name">
157<code class="descname">name</code><a class="headerlink" href="#eventmq.receiver.Receiver.name" title="Permalink to this definition">¶</a></dt> 154<code class="descname">name</code><a class="headerlink" href="#eventmq.receiver.Receiver.name" title="Permalink to this definition">¶</a></dt>
158<dd><p><em>str</em> &#8211; Name of this socket</p> 155<dd><p><em>str</em></p>
156<p>Name of this socket</p>
159</dd></dl> 157</dd></dl>
160 158
161<dl class="attribute"> 159<dl class="attribute">
162<dt id="eventmq.receiver.Receiver.zcontext"> 160<dt id="eventmq.receiver.Receiver.zcontext">
163<code class="descname">zcontext</code><a class="headerlink" href="#eventmq.receiver.Receiver.zcontext" title="Permalink to this definition">¶</a></dt> 161<code class="descname">zcontext</code><a class="headerlink" href="#eventmq.receiver.Receiver.zcontext" title="Permalink to this definition">¶</a></dt>
164<dd><p><a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a> &#8211; socket context</p> 162<dd><p><a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a></p>
163<p>socket context</p>
165</dd></dl> 164</dd></dl>
166 165
167<dl class="attribute"> 166<dl class="attribute">
168<dt id="eventmq.receiver.Receiver.zsocket"> 167<dt id="eventmq.receiver.Receiver.zsocket">
169<code class="descname">zsocket</code><a class="headerlink" href="#eventmq.receiver.Receiver.zsocket" title="Permalink to this definition">¶</a></dt> 168<code class="descname">zsocket</code><a class="headerlink" href="#eventmq.receiver.Receiver.zsocket" title="Permalink to this definition">¶</a></dt>
170<dd><p><a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a></p> 169<dd><p><a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a></p>
171</dd></dl> 170</dd></dl>
172 171
173<dl class="method"> 172<dl class="method">
@@ -182,16 +181,17 @@
182<col class="field-body" /> 181<col class="field-body" />
183<tbody valign="top"> 182<tbody valign="top">
184<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 183<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
185<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of this socket. By default a uuid will be 184<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of this socket. By default a uuid will be
186generated</li> 185generated</li>
187<li><strong>context</strong> (<a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a>) &#8211; Context to use when buliding the 186<li><strong>context</strong> (<a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a>) &#8211; Context to use when buliding the
188socket</li> 187socket</li>
189<li><strong>socket</strong> (<a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a>) &#8211; Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REP</span></code> or 188<li><strong>socket</strong> (<a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a>) &#8211; Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REP</span></code> or
190<code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code>. By default a <cite>ROUTER</cite> is used</li> 189<code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code>. By default a <cite>ROUTER</cite> is used</li>
191</ul> 190</ul>
192</td> 191</td>
193</tr> 192</tr>
194<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">TypeError</span></code> &#8211; when <cite>callable</cite> is not callable</p> 193<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal"><span class="pre">:class</span></code> &#8211;
194<cite>TypeError</cite>: when <cite>callable</cite> is not callable</p>
195</td> 195</td>
196</tr> 196</tr>
197</tbody> 197</tbody>
@@ -206,9 +206,10 @@ socket</li>
206<col class="field-name" /> 206<col class="field-name" />
207<col class="field-body" /> 207<col class="field-body" />
208<tbody valign="top"> 208<tbody valign="top">
209<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to connect to as a connection string</td> 209<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to connect to as a connection string</td>
210</tr> 210</tr>
211<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></td> 211<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">:class</span></code> &#8211;
212<cite>Exception</cite></td>
212</tr> 213</tr>
213</tbody> 214</tbody>
214</table> 215</table>
@@ -222,9 +223,10 @@ socket</li>
222<col class="field-name" /> 223<col class="field-name" />
223<col class="field-body" /> 224<col class="field-body" />
224<tbody valign="top"> 225<tbody valign="top">
225<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to listen on as a connction string</td> 226<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to listen on as a connction string</td>
226</tr> 227</tr>
227<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></td> 228<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">:class</span></code> &#8211;
229<cite>Exception</cite></td>
228</tr> 230</tr>
229</tbody> 231</tbody>
230</table> 232</table>
@@ -238,13 +240,10 @@ socket</li>
238<col class="field-name" /> 240<col class="field-name" />
239<col class="field-body" /> 241<col class="field-body" />
240<tbody valign="top"> 242<tbody valign="top">
241<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> 243<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the receiver is ready to connect or listen, otherwise
242<dt>True if the receiver is ready to connect or listen, otherwise</dt> 244False</td>
243<dd>False</dd>
244</dl>
245</td>
246</tr> 245</tr>
247<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 246<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
248</tr> 247</tr>
249</tbody> 248</tbody>
250</table> 249</table>
@@ -258,9 +257,10 @@ socket</li>
258<col class="field-name" /> 257<col class="field-name" />
259<col class="field-body" /> 258<col class="field-body" />
260<tbody valign="top"> 259<tbody valign="top">
261<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to disconnect from as a string</td> 260<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to disconnect from as a string</td>
262</tr> 261</tr>
263<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></td> 262<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">:class</span></code> &#8211;
263<cite>Exception</cite></td>
264</tr> 264</tr>
265</tbody> 265</tbody>
266</table> 266</table>
diff --git a/router.html b/router.html
index 1d2bb42..6c6e29e 100644
--- a/router.html
+++ b/router.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="up" title="API Documentation" href="api.html"/> 34 <link rel="up" title="API Documentation" href="api.html"/>
38 <link rel="next" title="sender – Sender" href="sender.html"/> 35 <link rel="next" title="sender – Sender" href="sender.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -93,7 +90,7 @@
93<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> 90<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>
94<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li> 91<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li>
95<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> 92<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>
96<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> 93<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>
97<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> 94<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>
98<li class="toctree-l2"><a class="reference internal" href="utils/index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li> 95<li class="toctree-l2"><a class="reference internal" href="utils/index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
99</ul> 96</ul>
@@ -121,7 +118,7 @@
121 <div class="rst-content"> 118 <div class="rst-content">
122 119
123 120
124 121
125 122
126 123
127 124
@@ -160,7 +157,7 @@
160<col class="field-name" /> 157<col class="field-name" />
161<col class="field-body" /> 158<col class="field-body" />
162<tbody valign="top"> 159<tbody valign="top">
163<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>scheduler_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; unique id of the scheduler to add</td> 160<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>scheduler_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; unique id of the scheduler to add</td>
164</tr> 161</tr>
165</tbody> 162</tbody>
166</table> 163</table>
@@ -175,7 +172,7 @@
175<col class="field-body" /> 172<col class="field-body" />
176<tbody valign="top"> 173<tbody valign="top">
177<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 174<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
178<li><strong>worker_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; unique id of the worker to add</li> 175<li><strong>worker_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; unique id of the worker to add</li>
179<li><strong>queues</strong> &#8211; queue or queues this worker should be a member of</li> 176<li><strong>queues</strong> &#8211; queue or queues this worker should be a member of</li>
180</ul> 177</ul>
181</td> 178</td>
@@ -207,13 +204,15 @@ queue.</p>
207<col class="field-name" /> 204<col class="field-name" />
208<col class="field-body" /> 205<col class="field-body" />
209<tbody valign="top"> 206<tbody valign="top">
210<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>queue_name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the queue</p> 207<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>queue_name</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the queue</p>
211</td> 208</td>
212</tr> 209</tr>
213<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first simple"> 210<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first simple">
214<li><code class="xref py py-exc docutils literal"><span class="pre">NoAvailableWorkerSlotsError</span></code> &#8211; Raised when there are no available</li> 211<li><code class="xref py py-exc docutils literal"><span class="pre">NoAvailableWorkerSlotsError</span></code> &#8211;
215<li>slots in any the job managers.</li> 212Raised when there are no available</li>
216<li><code class="xref py py-exc docutils literal"><span class="pre">UnknownQueueError</span></code> &#8211; Raised when <code class="docutils literal"><span class="pre">queue_name</span></code> is not found in 213<li><strong>slots in any the job managers.</strong> &#8211;</li>
214<li><code class="xref py py-exc docutils literal"><span class="pre">UnknownQueueError</span></code> &#8211;
215Raised when <code class="docutils literal"><span class="pre">queue_name</span></code> is not found in
217self.queues</li> 216self.queues</li>
218</ul> 217</ul>
219</td> 218</td>
@@ -231,10 +230,14 @@ self.queues</li>
231<dl class="method"> 230<dl class="method">
232<dt id="eventmq.router.Router.get_status"> 231<dt id="eventmq.router.Router.get_status">
233<code class="descname">get_status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.get_status" title="Permalink to this definition">¶</a></dt> 232<code class="descname">get_status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.get_status" title="Permalink to this definition">¶</a></dt>
234<dd><dl class="docutils"> 233<dd><table class="docutils field-list" frame="void" rules="none">
235<dt>Return</dt> 234<col class="field-name" />
236<dd>(str) Serialized information about the current state of the router.</dd> 235<col class="field-body" />
237</dl> 236<tbody valign="top">
237<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">(str) Serialized information about the current state of the router.</td>
238</tr>
239</tbody>
240</table>
238</dd></dl> 241</dd></dl>
239 242
240<dl class="attribute"> 243<dl class="attribute">
@@ -276,8 +279,8 @@ and announces itself.</p>
276<col class="field-body" /> 279<col class="field-body" />
277<tbody valign="top"> 280<tbody valign="top">
278<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 281<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
279<li><strong>sender</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The id of the sender</li> 282<li><strong>sender</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The id of the sender</li>
280<li><strong>msgid</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Unique identifier for this message</li> 283<li><strong>msgid</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Unique identifier for this message</li>
281<li><strong>msg</strong> &#8211; The actual message that was sent</li> 284<li><strong>msg</strong> &#8211; The actual message that was sent</li>
282</ul> 285</ul>
283</td> 286</td>
@@ -305,7 +308,7 @@ measurements</p>
305<li><strong>sender</strong> &#8211; </li> 308<li><strong>sender</strong> &#8211; </li>
306<li><strong>msgid</strong> &#8211; </li> 309<li><strong>msgid</strong> &#8211; </li>
307<li><strong>msgid</strong> &#8211; </li> 310<li><strong>msgid</strong> &#8211; </li>
308<li><strong>depth</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; The recusion depth in retrying when PeerGoneAwayError 311<li><strong>depth</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; The recusion depth in retrying when PeerGoneAwayError
309is raised.</li> 312is raised.</li>
310</ul> 313</ul>
311</td> 314</td>
@@ -322,11 +325,11 @@ is raised.</li>
322<col class="field-name" /> 325<col class="field-name" />
323<col class="field-body" /> 326<col class="field-body" />
324<tbody valign="top"> 327<tbody valign="top">
325<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>unprioritized_iterable</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#iter" title="(in Python v2.7)"><em>iter</em></a>) &#8211; Any list, tuple, etc where the 328<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>unprioritized_iterable</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#iter" title="(in Python v2.7)"><em>iter</em></a>) &#8211; Any list, tuple, etc where the
3260-index key is an integer to use as priority. Largest numbers 3290-index key is an integer to use as priority. Largest numbers
327come first.</td> 330come first.</td>
328</tr> 331</tr>
329<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body">IndexError - There was no 0-index element.</td> 332<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>IndexError - There was no 0-index element.</strong> &#8211;</td>
330</tr> 333</tr>
331<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">decsending order list. E.g. ((20, &#8216;a&#8217;), (14, &#8216;b&#8217;), (12, &#8216;c&#8217;))</td> 334<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">decsending order list. E.g. ((20, &#8216;a&#8217;), (14, &#8216;b&#8217;), (12, &#8216;c&#8217;))</td>
332</tr> 335</tr>
@@ -348,7 +351,8 @@ called. This is used to short circuit message retry attempts.</li>
348</ul> 351</ul>
349</td> 352</td>
350</tr> 353</tr>
351<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal"><span class="pre">InvalidMessageError</span></code> &#8211; Unable to parse the message</p> 354<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal"><span class="pre">InvalidMessageError</span></code> &#8211;
355Unable to parse the message</p>
352</td> 356</td>
353</tr> 357</tr>
354</tbody> 358</tbody>
@@ -409,7 +413,7 @@ worker slot, so you may see duplicate addresses.</p>
409<dl class="attribute"> 413<dl class="attribute">
410<dt id="eventmq.router.Router.scheduler_queue"> 414<dt id="eventmq.router.Router.scheduler_queue">
411<code class="descname">scheduler_queue</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.router.Router.scheduler_queue" title="Permalink to this definition">¶</a></dt> 415<code class="descname">scheduler_queue</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.router.Router.scheduler_queue" title="Permalink to this definition">¶</a></dt>
412<dd><p><em>Queue for schedulers to use</em></p> 416<dd><p>Queue for schedulers to use:</p>
413</dd></dl> 417</dd></dl>
414 418
415<dl class="attribute"> 419<dl class="attribute">
@@ -437,8 +441,8 @@ Contains dictionaries:</p>
437<col class="field-body" /> 441<col class="field-body" />
438<tbody valign="top"> 442<tbody valign="top">
439<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 443<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
440<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The socket to use for this ack</li> 444<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The socket to use for this ack</li>
441<li><strong>recipient</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The recipient id for the ack</li> 445<li><strong>recipient</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The recipient id for the ack</li>
442<li><strong>msgid</strong> &#8211; The unique id that we are acknowledging</li> 446<li><strong>msgid</strong> &#8211; The unique id that we are acknowledging</li>
443</ul> 447</ul>
444</td> 448</td>
@@ -463,8 +467,8 @@ needed when building messages</p>
463<col class="field-body" /> 467<col class="field-body" />
464<tbody valign="top"> 468<tbody valign="top">
465<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 469<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
466<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; the socket to send the heartbeat with</li> 470<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; the socket to send the heartbeat with</li>
467<li><strong>recipient</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Worker I</li> 471<li><strong>recipient</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Worker I</li>
468</ul> 472</ul>
469</td> 473</td>
470</tr> 474</tr>
@@ -506,9 +510,9 @@ process receives a SIGHUP from the system.</p>
506<col class="field-body" /> 510<col class="field-body" />
507<tbody valign="top"> 511<tbody valign="top">
508<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 512<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
509<li><strong>frontend_addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to listen for requests</li> 513<li><strong>frontend_addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to listen for requests</li>
510<li><strong>backend_addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to listen for workers</li> 514<li><strong>backend_addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to listen for workers</li>
511<li><strong>administrative_addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to listen for emq-cli 515<li><strong>administrative_addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to listen for emq-cli
512commands on.</li> 516commands on.</li>
513</ul> 517</ul>
514</td> 518</td>
diff --git a/search.html b/search.html
index de4e383..f61df01 100644
--- a/search.html
+++ b/search.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="#"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 34
38 35
@@ -61,7 +58,7 @@
61 58
62 59
63 <div class="version"> 60 <div class="version">
64 0.2.6.3 61 0.2.6.5
65 </div> 62 </div>
66 63
67 64
diff --git a/searchindex.js b/searchindex.js
index 9c0e574..e279406 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
Search.setIndex({envversion:49,filenames:["api","client","client/messages","contributing","exceptions","index","jobmanager","poller","protocol","receiver","router","sender","settings_file","using","utils/classes","utils/devices","utils/index","utils/messages","utils/settings","utils/timeutils"],objects:{"eventmq.client":{messages:[2,0,0,"-"]},"eventmq.client.messages":{defer_job:[2,1,1,""],schedule:[2,1,1,""],send_request:[2,1,1,""],send_schedule_request:[2,1,1,""]},"eventmq.exceptions":{CallableFromPathError:[4,2,1,""],EventMQError:[4,2,1,""],InvalidMessageError:[4,2,1,""],MessageError:[4,2,1,""],NoAvailableWorkerSlotsError:[4,2,1,""],PeerGoneAwayError:[4,2,1,""],UnknownQueueError:[4,2,1,""]},"eventmq.jobmanager":{JobManager:[6,3,1,""],mp_init:[6,1,1,""]},"eventmq.jobmanager.JobManager":{__init__:[6,4,1,""],concurrent_jobs:[6,5,1,""],jobmanager_main:[6,4,1,""],name:[6,5,1,""],on_heartbeat:[6,4,1,""],on_request:[6,4,1,""],outgoing:[6,5,1,""],queues:[6,5,1,""],send_ready:[6,4,1,""],send_reply:[6,4,1,""]},"eventmq.poller":{Poller:[7,3,1,""]},"eventmq.poller.Poller":{__init__:[7,4,1,""],poll:[7,4,1,""],register:[7,4,1,""],unregister:[7,4,1,""]},"eventmq.receiver":{Receiver:[9,3,1,""]},"eventmq.receiver.Receiver":{__init__:[9,4,1,""],connect:[9,4,1,""],listen:[9,4,1,""],name:[9,5,1,""],ready:[9,5,1,""],unbind:[9,4,1,""],zcontext:[9,5,1,""],zsocket:[9,5,1,""]},"eventmq.router":{Router:[10,3,1,""]},"eventmq.router.Router":{add_scheduler:[10,4,1,""],add_worker:[10,4,1,""],clean_up_dead_schedulers:[10,4,1,""],clean_up_dead_workers:[10,4,1,""],get_available_worker:[10,4,1,""],get_status:[10,4,1,""],job_latencies:[10,5,1,""],on_disconnect:[10,4,1,""],on_heartbeat:[10,4,1,""],on_inform:[10,4,1,""],on_ready:[10,4,1,""],on_reply:[10,4,1,""],on_request:[10,4,1,""],prioritize_queue_list:[10,6,1,""],process_client_message:[10,4,1,""],process_worker_message:[10,4,1,""],queues:[10,5,1,""],received_disconnect:[10,5,1,""],requeue_worker:[10,4,1,""],reset_heartbeat_counters:[10,4,1,""],router_main:[10,4,1,""],scheduler_queue:[10,5,1,""],schedulers:[10,5,1,""],send_ack:[10,4,1,""],send_heartbeat:[10,4,1,""],send_schedulers_heartbeats:[10,4,1,""],send_workers_heartbeats:[10,4,1,""],sighup_handler:[10,4,1,""],start:[10,4,1,""],waiting_messages:[10,5,1,""],workers:[10,5,1,""]},"eventmq.sender":{Sender:[11,3,1,""]},"eventmq.sender.Sender":{__init__:[11,4,1,""],connect:[11,4,1,""],listen:[11,4,1,""],name:[11,5,1,""],ready:[11,5,1,""],rebuild:[11,4,1,""],unbind:[11,4,1,""],zcontext:[11,5,1,""],zsocket:[11,5,1,""]},"eventmq.utils":{classes:[14,0,0,"-"],devices:[15,0,0,"-"],messages:[17,0,0,"-"],random_characters:[16,1,1,""],settings:[18,0,0,"-"],timeutils:[19,0,0,"-"],tuplify:[16,1,1,""],zero_index_cmp:[16,1,1,""]},"eventmq.utils.classes":{EMQPService:[14,3,1,""],EMQdeque:[14,3,1,""],HeartbeatMixin:[14,3,1,""],ZMQReceiveMixin:[14,3,1,""],ZMQSendMixin:[14,3,1,""]},"eventmq.utils.classes.EMQPService":{__weakref__:[14,5,1,""],is_heartbeat_enabled:[14,5,1,""],on_ack:[14,4,1,""],process_message:[14,4,1,""],reset:[14,4,1,""],send_inform:[14,4,1,""],start:[14,4,1,""]},"eventmq.utils.classes.EMQdeque":{__init__:[14,4,1,""],__weakref__:[14,5,1,""],append:[14,4,1,""],appendleft:[14,4,1,""],extend:[14,4,1,""],is_empty:[14,4,1,""],is_full:[14,4,1,""],is_pfull:[14,4,1,""],pop:[14,4,1,""],popleft:[14,4,1,""],remove:[14,4,1,""]},"eventmq.utils.classes.HeartbeatMixin":{__init__:[14,4,1,""],__weakref__:[14,5,1,""],is_dead:[14,4,1,""],reset_heartbeat_counters:[14,4,1,""],send_heartbeat:[14,4,1,""]},"eventmq.utils.classes.ZMQReceiveMixin":{__weakref__:[14,5,1,""],recv:[14,4,1,""],recv_multipart:[14,4,1,""]},"eventmq.utils.classes.ZMQSendMixin":{__weakref__:[14,5,1,""],send:[14,4,1,""],send_multipart:[14,4,1,""]},"eventmq.utils.devices":{generate_device_name:[15,1,1,""]},"eventmq.utils.messages":{fwd_emqp_router_message:[17,1,1,""],generate_msgid:[17,1,1,""],parse_message:[17,1,1,""],parse_router_message:[17,1,1,""],send_emqp_message:[17,1,1,""],send_emqp_router_message:[17,1,1,""]},"eventmq.utils.settings":{import_settings:[18,1,1,""]},"eventmq.utils.timeutils":{IntervalIter:[19,3,1,""],monotonic:[19,1,1,""],seconds_until:[19,1,1,""],timestamp:[19,1,1,""]},"eventmq.utils.timeutils.IntervalIter":{__init__:[19,4,1,""],__weakref__:[19,5,1,""]},eventmq:{client:[1,0,0,"-"],exceptions:[4,0,0,"-"],jobmanager:[6,0,0,"-"],poller:[7,0,0,"-"],receiver:[9,0,0,"-"],router:[10,0,0,"-"],sender:[11,0,0,"-"],utils:[16,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","exception","Python exception"],"3":["py","class","Python class"],"4":["py","method","Python method"],"5":["py","attribute","Python attribute"],"6":["py","classmethod","Python class method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:exception","3":"py:class","4":"py:method","5":"py:attribute","6":"py:classmethod"},terms:{"0mq":[8,14],"5min":19,"abstract":8,"boolean":14,"case":[8,14,19],"class":[0,2,6,7,9,10,11],"default":[2,6,8,9,10,11,12,14],"float":[14,19],"function":[2,6],"import":[2,3,6,10,12,18],"int":[2,7,8,10,14,19],"long":[7,14],"new":[6,10,14],"public":8,"return":[2,3,7,9,10,11,14,15,16,17,19],"short":10,"true":[8,9,10,11,14],"while":8,__init__:[6,7,9,11,14,19],__weakref__:[14,19],_empty_:8,_headers_:8,_msg_:8,_msgid_:8,_queue_name_:8,_queues_:8,_recipient_id:14,_topic_name_:8,_unix_ts_:8,abl:[10,12],about:[6,8,10],absolut:3,accept:[8,12,14],account:[10,17],ack:[6,8,10],ackd_msgid:14,acknowledg:[6,8,10],across:8,act:[1,8],actual:[6,10],add:10,add_schedul:10,add_work:10,addr:[9,11,14],address:6,administrative_addr:10,after:8,agre:8,all:[2,4,6,8,9,10,11,14],allow:8,alpha:8,alreadi:10,also:14,alwai:2,and_data:17,ani:[2,8,10,16],announc:10,anoth:[6,10,12],any:[8,10],anyth:12,app:14,appear:7,append:14,appendleft:14,appened:10,appli:18,applic:[2,8],arg2:2,arg3:2,arg:[2,6,7,9,10,11,14],argument:14,arithmet:19,arrai:8,ascii:15,assign:12,assum:19,attempt:[4,10],attr:7,automat:14,avail:[4,10],available_slot:10,awaiting_ack:14,back:[8,10,14],backend_addr:10,backward:14,base:[4,7,12,14],basi:8,becaus:[10,14],becom:12,been:[2,10,14],befor:[2,7,8],begin:[10,12,14],belong:10,below:8,best:2,between:[2,8],block:12,bool:[2,6,9,11,14],boot:19,both:[7,8],box:12,broadcast:8,broker:[6,8,14],broker_addr:6,buffer:10,build:[10,11],built:8,bulid:9,calcul:19,call:[2,7,10,14],callabl:[2,4,6,9],callable_nam:4,callablefrompatherror:4,callback:14,can:[1,2,6,8,10,14,15,17],captur:14,care:15,caus:15,certain:14,chang:8,charact:16,check:[9,11,14],child:6,choos:12,circuit:10,class_arg:[2,6],class_kwarg:[2,6],classmethod:10,clean:8,clean_up_dead_schedul:10,clean_up_dead_work:10,clear:10,cli:10,client:0,clock:19,close:[14,19],cmp:16,code:[3,5,14],collect:14,colon:[2,12],come:[2,10],comma:8,command:[2,6,8,10,14,17],compar:16,compat:14,complet:8,compon:8,concurr:12,concurrent_job:6,concurrent_jobs:12,conf:12,config:12,configur:[2,10,18],connction:[9,11],connect:[6,8,9,10,11,14,17],consist:8,construct:4,contact:4,contain:[1,8,10,14,16],context:[6,9,11],control:12,contruct:14,convers:8,convert:16,convienc:[7,14],copi:6,core:12,count:[6,8,10,19],counter:[10,14],cpu:12,creat:[10,11,16],cron:2,csv:8,current:[9,10,11,14],custom:10,cycl:12,data:[10,17],data_process:12,deal:16,dealer:11,death:14,debounc:2,debounce_deferred_job:2,debounce_sec:2,debug:8,decsend:10,defeat:8,defer:2,defer_job:2,defin:[2,6,8,9,11,14,19],deliv:[6,8],denot:2,depth:10,dequ:14,describ:8,descript:8,detail:8,detect:8,determin:8,devic:[0,7,14],dialog:8,dict:[2,6,7],dictionari:[7,8,10],die:10,differ:3,directli:[7,14],disabl:2,distribut:8,doe:14,doesn:7,don:[6,8],dot:2,down:[12,19],dst:19,duplic:10,dure:11,each:10,effici:12,effort:2,either:[8,14],elaps:8,element:[10,14],els:[3,8],email:[8,12],empti:[8,17],emq:10,emqdequ:14,emqpservic:14,enabl:[2,14],encod:15,encount:[2,4],end:[2,14],ensur:[2,14],ensure:[6,8],entri:10,equal:12,error:[2,14,15],etc:[10,12],evalu:2,even:8,event:[7,14],eventmq:[1,2],eventmqerror:4,everi:[2,6],everyth:15,exampl:[10,12,14,19],except:[0,2,3],exception:[0,2],exectu:10,execut:[2,8,12,19],exist:[4,6],explicitli:[12,14],expos:6,extend:14,extra:8,fail:[2,4,8],failur:2,fair:8,fals:[2,8,9,11,14],featur:15,few:3,field:8,file:12,find:14,finish:[8,10],first:[8,10,14,17],fitness:8,flag:[2,7],follow:[2,8,14],fork:6,form:14,format:[2,6,8,10,17],forward:[10,14,17],found:[4,10,12],foundat:8,free:8,from:[4,6,7,8,9,10,11,14,19],frontend_addr:10,full:14,func:[2,6,14],fwd_emqp_router_messag:17,gener:[6,7,8,9,11,17],generate_device_nam:15,generate_msgid:17,get:10,get_available_work:10,get_statu:10,give:2,given:10,gnu:8,good:14,group:12,guarante:[2,8],guarente:2,hand:16,handl:[6,8,10,14],handler:6,happen:[2,7,10,11],hard:14,hasn:10,have:[2,12,14,17],haven:10,header:2,heartbeat:6,heartbeat_timeout:10,heartbeati:14,heartbeatmixin:14,heavi:8,help:12,helper:14,here:[8,10],highest:12,hit:14,hope:8,how:[2,7],html:8,http:8,ident:8,identifi:10,identity:15,ietf:8,ignor:8,ignore:14,immedi:[2,8],immediatli:2,implement:[8,14],impli:8,import_set:18,includ:[2,8,14],index:[5,10,16],indexerror:10,indic:6,indiviud:12,inform:[2,8,10,14],informing:6,inherit:4,ini:[12,18],initi:[2,14],insert:[8,14],instal:3,instanc:6,instanti:[2,6],instead:8,integ:10,intens:12,interest:16,intern:4,interpret:8,interv:[2,8,19],interval_sec:[2,19],intervalit:19,invalidmessageerror:[4,10],is_dead:14,is_empti:14,is_ful:14,is_heartbeat_en:14,is_pful:14,isn:[10,14],issu:8,issue:[3,5],item:14,iter:[7,10,14],iterat:14,itself:10,job:[0,1,2,4,5],job_lat:10,job_schedul:2,jobmanag:[0,5],jobmanager_main:6,keep:[6,10],kei:[7,8,10],kick:[6,10],know:[2,6,10],kwarg2:2,kwarg:[2,6,7,9,10,11,14],larg:12,larger:12,largest:10,last:[2,10,14],last_recv_heartbeat:10,lataneci:10,latenc:10,later:8,least:[8,14],leav:[8,12],left:14,length:[14,16],lesser:8,let:8,like:[6,14,16],limit:14,list:[2,4,6,8,10,12,14,16,19],listen:[6,9,10,11,12,14],load:12,local:12,locat:2,log:[2,6,10],logic:[6,10],longer:[4,12],look:14,loop:[7,10,14],lot:12,lower:10,mai:[10,14],main:6,make:16,malform:4,manag:[0,4,5],mani:[2,8,11],manual:8,master:8,match:14,may:8,measur:10,member:10,memebership:10,merchantability:8,mess:19,messag:[0,1],message_bodi:17,message_id:17,messageerror:4,met:14,meta:[10,17],method:[2,6,7,10,14],minut:2,model:12,modifi:8,modul:[1,5,6,16],monoton:[10,14,19],more:[2,8,14,16],most:14,mp_init:6,msg:[6,8,10,14,17],msgid:[6,10,14],multipart:[8,14],multiprocess:[6,12],must:[8,14],name:[2,6,8,9,10,11,12,18],need:[6,10,11],never:[6,19],next:[7,10,12,19],noavailableworkerslotserror:[4,10],nohast:8,none:[2,6,9,10,11,14,15,17],noop:6,normal:14,note:[6,9,11],notifi:14,now:14,number:[2,10,12,19],numer:19,obj:10,object:[7,14,16,19],occur:14,off:[6,10],on_ack:14,on_command:[10,14],on_disconnect:10,on_emqp_command:14,on_ful:14,on_heartbeat:[6,10],on_inform:10,on_readi:10,on_recv:9,on_repli:10,on_request:[6,10],on_schedul:14,once:8,onlin:[10,14],option:[2,6,8,9,11],optional:[2,8,17],order:10,org:8,orient:8,origin:8,original_msg:10,other:[2,8,12],otherwis:[6,9,11,14],out:[6,14],outgo:[6,14],own:14,page:5,param:2,paramet:[2,6,7,9,10,11,14,15,16,17,18,19],pars:[10,14,17],parse_messag:17,parse_router_messag:17,part:[8,17],particular:[8,11],pass:[2,8,9,14],path:[2,4,6],payload:17,peer:[4,8,14],peergoneawayerror:[4,10],pend:8,per:10,pfull:14,pictur:8,placehold:[6,10],point:12,poll:7,poller:[0,5],pollin:7,pollout:7,pool:[8,10],pop:[10,14],popleft:14,port:10,portion:6,possibl:3,practic:14,prefix:[15,17],prepar:10,prepend:8,pretti:[8,12],priorit:10,prioriti:10,prioritiess:10,prioritize_queue_list:10,priority:10,problem:4,process:[6,8,10,11,12,14],process_client_messag:10,process_messag:[6,14],process_worker_messag:10,programm:14,proper:14,properti:[9,11,14],protocol:[3,5],protocol_vers:14,provid:[10,14],pub:8,publish:8,purpose:8,push_notif:14,py2:19,py3:19,python3:15,python:[6,14],queue:[2,4,6,8,10],queue_nam:10,rais:[2,4,9,10,11,14,17],random:[16,17],random_charact:16,raw:14,readi:[6,9,10,11,12,14],ready:[6,8],rebind:10,rebuild:11,rebuilt:6,receiv:[0,2,3,5,8],received_disconnect:10,recent:[8,10],recipi:[6,10,14,17],recipient_id:17,recommend:[12,14],recommended:8,reconnect:11,recurs:[10,16],recus:10,recv:14,recv_multipart:14,redistribut:8,refer:[6,8,14,19],regist:[6,7,10],regular:8,reject:14,rel:3,reliabl:8,reload:10,remain:7,remot:14,remov:[8,10,14],reopen:14,rep:9,repli:[2,6,8,10,17],reply:[6,8,10],reply_request:2,repres:19,req:11,request:[1,2,6,8,10,14],requeue_work:10,requir:8,required:8,reset:[10,14],reset_heartbeat_count:[10,14],resourc:[6,8],respond:[8,10,14],respons:[6,9,10,11],restart:[8,11],retri:[2,8,10],retry_count:2,rfc2119:8,rfc:8,right:14,robin:8,roughli:11,round:8,rout:[8,10],router:[0,5,6],router_main:10,run:[2,6,8,10,12,14],safe:12,sake:19,same:[11,16],schedul:2,schedule:[2,8,10,14],scheduler_id:10,scheduler_queu:10,scheduler_zmq_id:10,search:5,sec:2,second:[2,19],seconds_until:19,section:18,see:[2,7,8,10,14],self:[6,10,11,14],semi:12,send:[2,4,6,8,10,11,14,17],send_ack:10,send_emqp_messag:17,send_emqp_router_messag:17,send_heartbeat:[10,14],send_inform:14,send_multipart:14,send_readi:6,send_repli:6,send_request:2,send_schedule_request:2,send_schedulers_heartbeat:10,send_workers_heartbeat:10,sender:[0,5,10],sender_id:17,sent:[2,6,8,10,12,14],seper:[2,8,12],serial:10,serv:8,server:[6,8,12],servic:[8,14],service_type:14,set:[0,5,6,7,8,10,11],shall:8,should:[2,4,7,8,9,10,11,12,14,17],shown:8,sighup:10,sighup_handl:10,signal:6,signum:10,similar:12,simpl:[10,16],sinc:19,singl:[8,14],size:14,skip:[11,14],skip_sign:6,skip_zmqstream:11,slot:10,slow:12,smaller:12,socket:[2,6,7,8,9,10,11,14,15,17],softwar:8,some:[2,6,12,14,16,17],someon:8,someth:[2,11,12,14,19],somewher:3,sort:16,sourc:[3,5],spawn:6,specif:[3,5],specifi:[8,14,16],standard:12,start:[6,9,10,11,12,14,19],start_valu:19,state:[10,14],statu:8,still:[10,12],stop:8,store:10,str:[2,6,9,10,11,14,15,16,17,18],string:[2,8,9,10,11,14,15,17],structur:4,style:12,sub:8,subclass:4,subcmd:6,subcommand:[2,6],subject:8,subset:8,subtract:19,success:8,successfulli:14,support:14,system:[3,10],take:[10,11,14,15,17],task:[2,6],tcp:10,tell:6,term:8,termin:6,test:6,thei:[2,14],them:9,thi:[1,2,4,6,7,8,9,10,11,12,14,15,16,17,19],thier:12,thing:[2,6,11,12,14,16,17],those:6,thread:12,threshold:14,through:[8,10],time:[0,2,8,10,12,14,16],timeout:7,timestamp:[8,10,19],timeutil:[0,14,16],tip:3,tool:8,topic:8,trace:8,track:[6,10,14],tri:2,tune:12,tupl:[6,7,10,14,16,17],tuplifi:16,type:[2,8,9,10,11,14,16,17],type_:14,typecast:7,typeerror:9,unabl:10,unbind:[9,11],undefin:7,under:8,unicod:15,uniqu:[6,8,10],unit:6,unix:8,unknownqueueerror:[4,10],unless:[6,9,11],unprioritized_iter:10,unregist:7,unschedul:2,unschedule:[2,8],until:[12,19],untouch:[10,17],unuse:8,updat:14,upon:8,upstream:6,usage:19,use:3,used:[2,10,16],useful:[6,14,17],using:5,usualli:14,util:[0,1,5,14,15],utilit:[0,16],utiliti:0,utlitii:14,uuid:[6,9,10,11],valid:8,valu:[2,7,8,10,14,16,17,19],valueerror:14,variabl:14,version:[3,8,14],via:[2,19],wait:[2,7,12],waiting_messag:10,walk:6,want:[8,12,14],warn:10,warranti:8,warranty:8,weak:[14,19],web:8,weight:[8,12,14],well:8,when:[1,2,3,4,6,8,9,10,11,14,15,16],where:[2,8,10,14,19],which:[8,10,14,15],who:[1,10],wish:17,without:[6,8,11],word:8,work:[3,6,14],worker:[2,4,6],worker_id:10,worri:8,would:[12,14,19],wrap:2,wrapper:2,you:[3,8,10,11,12,14,17],your:[2,8,12,14],zcontext:[9,11],zero_index_cmp:16,zeromq:8,zmq:[7,8,9,10,11,14,15,17],zmqreceivemixin:14,zmqsendmixin:14,zmqstream:11,zsocket:[9,11]},titles:["API Documentation","<code class=\"docutils literal\"><span class=\"pre\">client</span></code> &#8211; Client Utilities","<code class=\"docutils literal\"><span class=\"pre\">messages</span></code> &#8211; Client Messaging","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","<code class=\"docutils literal\"><span class=\"pre\">poller</span></code> &#8211; Poller","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","Settings","Using EventMQ","<code class=\"docutils literal\"><span class=\"pre\">classes</span></code> &#8211; Utility Classes","<code class=\"docutils literal\"><span class=\"pre\">devices</span></code> &#8211; Device Utilities","<code class=\"docutils literal\"><span class=\"pre\">utils</span></code> &#8211; Utilities","<code class=\"docutils literal\"><span class=\"pre\">messages</span></code> &#8211; Message Utilities","<code class=\"docutils literal\"><span class=\"pre\">settings</span></code> &#8211; Settings Utilities","<code class=\"docutils literal\"><span class=\"pre\">timeutils</span></code> &#8211; Time Utilites"],titleterms:{"class":14,address:8,api:0,architectur:8,client:[1,2,8],concurrent_job:12,contribut:3,devic:15,disconnect:8,document:[0,5],emqp:8,eventmq:[3,5,8,13],except:4,exception:4,frame:8,global:8,goal:8,header:8,heartbeat:8,indice:5,job:[6,12],jobmanag:6,kbai:8,languag:8,licens:8,manag:[6,12],messag:[2,17],poller:7,protocol:8,queue:12,receiv:9,router:[8,10,12],schedul:[8,12],sender:11,set:[12,18],specif:8,tabl:5,time:19,timeutil:19,topolog:8,using:13,util:16,utilit:19,utiliti:[1,14,15,16,17,18],worker:8}}) \ No newline at end of file Search.setIndex({envversion:46,filenames:["api","client","client/messages","contributing","exceptions","index","jobmanager","poller","protocol","receiver","router","sender","settings_file","using","utils/classes","utils/devices","utils/index","utils/messages","utils/settings","utils/timeutils"],objects:{"eventmq.client":{messages:[2,0,0,"-"]},"eventmq.client.messages":{defer_job:[2,3,1,""],schedule:[2,3,1,""],send_request:[2,3,1,""],send_schedule_request:[2,3,1,""]},"eventmq.exceptions":{CallableFromPathError:[4,5,1,""],EventMQError:[4,5,1,""],InvalidMessageError:[4,5,1,""],MessageError:[4,5,1,""],NoAvailableWorkerSlotsError:[4,5,1,""],PeerGoneAwayError:[4,5,1,""],UnknownQueueError:[4,5,1,""]},"eventmq.jobmanager":{JobManager:[6,4,1,""],mp_init:[6,3,1,""]},"eventmq.jobmanager.JobManager":{"__init__":[6,2,1,""],concurrent_jobs:[6,1,1,""],jobmanager_main:[6,2,1,""],name:[6,1,1,""],on_heartbeat:[6,2,1,""],on_request:[6,2,1,""],outgoing:[6,1,1,""],queues:[6,1,1,""],send_ready:[6,2,1,""],send_reply:[6,2,1,""]},"eventmq.poller":{Poller:[7,4,1,""]},"eventmq.poller.Poller":{"__init__":[7,2,1,""],poll:[7,2,1,""],register:[7,2,1,""],unregister:[7,2,1,""]},"eventmq.receiver":{Receiver:[9,4,1,""]},"eventmq.receiver.Receiver":{"__init__":[9,2,1,""],connect:[9,2,1,""],listen:[9,2,1,""],name:[9,1,1,""],ready:[9,1,1,""],unbind:[9,2,1,""],zcontext:[9,1,1,""],zsocket:[9,1,1,""]},"eventmq.router":{Router:[10,4,1,""]},"eventmq.router.Router":{add_scheduler:[10,2,1,""],add_worker:[10,2,1,""],clean_up_dead_schedulers:[10,2,1,""],clean_up_dead_workers:[10,2,1,""],get_available_worker:[10,2,1,""],get_status:[10,2,1,""],job_latencies:[10,1,1,""],on_disconnect:[10,2,1,""],on_heartbeat:[10,2,1,""],on_inform:[10,2,1,""],on_ready:[10,2,1,""],on_reply:[10,2,1,""],on_request:[10,2,1,""],prioritize_queue_list:[10,6,1,""],process_client_message:[10,2,1,""],process_worker_message:[10,2,1,""],queues:[10,1,1,""],received_disconnect:[10,1,1,""],requeue_worker:[10,2,1,""],reset_heartbeat_counters:[10,2,1,""],router_main:[10,2,1,""],scheduler_queue:[10,1,1,""],schedulers:[10,1,1,""],send_ack:[10,2,1,""],send_heartbeat:[10,2,1,""],send_schedulers_heartbeats:[10,2,1,""],send_workers_heartbeats:[10,2,1,""],sighup_handler:[10,2,1,""],start:[10,2,1,""],waiting_messages:[10,1,1,""],workers:[10,1,1,""]},"eventmq.sender":{Sender:[11,4,1,""]},"eventmq.sender.Sender":{"__init__":[11,2,1,""],connect:[11,2,1,""],listen:[11,2,1,""],name:[11,1,1,""],ready:[11,1,1,""],rebuild:[11,2,1,""],unbind:[11,2,1,""],zcontext:[11,1,1,""],zsocket:[11,1,1,""]},"eventmq.utils":{classes:[14,0,0,"-"],devices:[15,0,0,"-"],messages:[17,0,0,"-"],random_characters:[16,3,1,""],settings:[18,0,0,"-"],timeutils:[19,0,0,"-"],tuplify:[16,3,1,""],zero_index_cmp:[16,3,1,""]},"eventmq.utils.classes":{EMQPService:[14,4,1,""],EMQdeque:[14,4,1,""],HeartbeatMixin:[14,4,1,""],ZMQReceiveMixin:[14,4,1,""],ZMQSendMixin:[14,4,1,""]},"eventmq.utils.classes.EMQPService":{"__weakref__":[14,1,1,""],is_heartbeat_enabled:[14,1,1,""],on_ack:[14,2,1,""],process_message:[14,2,1,""],reset:[14,2,1,""],send_inform:[14,2,1,""],start:[14,2,1,""]},"eventmq.utils.classes.EMQdeque":{"__init__":[14,2,1,""],"__weakref__":[14,1,1,""],append:[14,2,1,""],appendleft:[14,2,1,""],extend:[14,2,1,""],is_empty:[14,2,1,""],is_full:[14,2,1,""],is_pfull:[14,2,1,""],peek:[14,2,1,""],peekleft:[14,2,1,""],pop:[14,2,1,""],popleft:[14,2,1,""],remove:[14,2,1,""]},"eventmq.utils.classes.HeartbeatMixin":{"__init__":[14,2,1,""],"__weakref__":[14,1,1,""],is_dead:[14,2,1,""],reset_heartbeat_counters:[14,2,1,""],send_heartbeat:[14,2,1,""]},"eventmq.utils.classes.ZMQReceiveMixin":{"__weakref__":[14,1,1,""],recv:[14,2,1,""],recv_multipart:[14,2,1,""]},"eventmq.utils.classes.ZMQSendMixin":{"__weakref__":[14,1,1,""],send:[14,2,1,""],send_multipart:[14,2,1,""]},"eventmq.utils.devices":{generate_device_name:[15,3,1,""]},"eventmq.utils.messages":{fwd_emqp_router_message:[17,3,1,""],generate_msgid:[17,3,1,""],parse_message:[17,3,1,""],parse_router_message:[17,3,1,""],send_emqp_message:[17,3,1,""],send_emqp_router_message:[17,3,1,""]},"eventmq.utils.settings":{import_settings:[18,3,1,""]},"eventmq.utils.timeutils":{IntervalIter:[19,4,1,""],monotonic:[19,3,1,""],seconds_until:[19,3,1,""],timestamp:[19,3,1,""]},"eventmq.utils.timeutils.IntervalIter":{"__init__":[19,2,1,""],"__weakref__":[19,1,1,""]},eventmq:{client:[1,0,0,"-"],exceptions:[4,0,0,"-"],jobmanager:[6,0,0,"-"],poller:[7,0,0,"-"],receiver:[9,0,0,"-"],router:[10,0,0,"-"],sender:[11,0,0,"-"],utils:[16,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"],"6":["py","classmethod","Python class method"]},objtypes:{"0":"py:module","1":"py:attribute","2":"py:method","3":"py:function","4":"py:class","5":"py:exception","6":"py:classmethod"},terms:{"0mq":[8,14],"5min":19,"__init__":[6,7,9,11,14,19],"__weakref__":[14,19],"_empty_":8,"_headers_":8,"_msg_":8,"_msgid_":8,"_queue_name_":8,"_queues_":8,"_recipient_id":14,"_topic_name_":8,"_unix_ts_":8,"abstract":8,"boolean":14,"case":[8,14,19],"class":[],"default":[2,6,8,9,10,11,12,14],"float":[14,19],"function":[2,6],"import":[2,3,6,10,12,18],"int":[2,7,8,10,14,19],"long":[7,14],"new":[6,10,14],"public":8,"return":[2,3,7,9,10,11,14,15,16,17,19],"short":10,"true":[8,9,10,11,14],"while":8,abl:[10,12],about:[6,8,10],absolut:3,accept:[8,12,14],account:[10,17],ack:[6,8,10],ackd_msgid:14,acknowledg:[6,8,10],across:8,act:[1,8],actual:[6,10],add:10,add_schedul:10,add_work:10,addr:[9,11,14],address:[],administrative_addr:10,after:8,agre:8,all:[2,4,6,8,9,10,11,14],allow:8,alpha:8,alreadi:10,also:14,alwai:2,and_data:17,ani:[2,8,10,16],announc:10,anoth:[6,10,12],anyth:12,app:14,appear:7,append:14,appendleft:14,appened:10,appli:18,applic:[2,8],arg2:2,arg3:2,arg:[2,6,7,9,10,11,14],argument:14,arithmet:19,arrai:8,ascii:15,assign:12,assum:19,attempt:[4,10],attr:7,automat:14,avail:[4,10],available_slot:10,awaiting_ack:14,back:[8,10,14],backend_addr:10,backward:14,base:[4,7,12,14],basi:8,becaus:[10,14],becom:12,been:[2,10,14],befor:[2,7,8],begin:[10,12,14,19],belong:10,below:8,best:2,between:[2,8,19],block:12,bool:[2,6,9,11,14],boot:19,both:[7,8],box:12,broadcast:8,broker:[6,8,14],broker_addr:6,buffer:10,build:[10,11],built:8,bulid:9,calcul:19,call:[2,7,10,14],callabl:[2,4,6,9],callable_nam:4,callablefrompatherror:4,callback:14,can:[1,2,6,8,10,14,15,17],captur:14,care:15,caus:15,certain:14,chang:8,charact:16,check:[9,11,14],child:6,choos:12,circuit:10,class_arg:[2,6],class_kwarg:[2,6],classmethod:10,clean:8,clean_up_dead_schedul:10,clean_up_dead_work:10,clear:10,cli:10,client:[],clock:19,close:[14,19],cmp:16,code:[3,5,14],collect:14,colon:[2,12],come:[2,10],comma:8,command:[2,6,8,10,14,17],compar:16,compat:14,complet:8,compon:8,concurr:12,concurrent_job:[],conf:12,config:12,configur:[2,10,18],connction:[9,11],connect:[6,8,9,10,11,14,17],consist:8,construct:4,contact:4,contain:[1,8,10,14,16],context:[6,9,11],control:12,contruct:14,convers:8,convert:16,convienc:[7,14],copi:6,core:12,count:[6,8,10,19],counter:[10,14],cpu:12,creat:[10,11,16],cron:2,csv:8,current:[9,10,11,14],custom:10,cycl:12,data:[10,17],data_process:12,deal:16,dealer:11,death:14,debounc:2,debounce_deferred_job:2,debounce_sec:2,debug:8,decsend:10,defeat:8,defer:2,defer_job:2,defin:[2,6,8,9,11,14,19],deliv:[6,8],denot:2,depth:10,dequ:14,describ:8,descript:8,detail:8,detect:8,determin:8,devic:[],dialog:8,dict:[2,6,7],dictionari:[7,8,10],die:10,differ:3,directli:[7,14],disabl:2,distribut:8,doe:14,doesn:7,don:[6,8],dot:2,down:[12,19],dst:19,duplic:10,dure:11,each:10,effici:12,effort:2,either:[8,14],elaps:8,element:[10,14],els:[3,8],email:[8,12],empti:[8,17],emq:10,emqdequ:14,emqpservic:14,enabl:[2,14],encod:15,encount:[2,4],end:[2,14],ensur:[2,6,8,14],entri:10,equal:12,error:[2,14,15],etc:[10,12],evalu:2,even:8,event:[7,14],eventmq:[],eventmqerror:4,everi:[2,6],everyth:15,exampl:[10,12,14,19],except:[],exectu:10,execut:[2,8,12,19],exist:[4,6],explicitli:[12,14],expos:6,extend:14,extra:8,fail:[2,4,8],failur:2,fair:8,fals:[2,8,9,11,14],featur:15,few:3,field:8,file:12,find:14,finish:[8,10],first:[8,10,14,17],fit:8,flag:[2,7],follow:[2,8,14],fork:6,form:14,format:[2,6,8,10,17],forward:[10,14,17],found:[4,10,12],foundat:8,free:8,from:[4,6,7,8,9,10,11,14,19],frontend_addr:10,fuction:2,full:14,func:[2,6,14],fwd_emqp_router_messag:17,gener:[6,7,8,9,11,17],generate_device_nam:15,generate_msgid:17,get:10,get_available_work:10,get_statu:10,give:2,given:10,gnu:8,good:14,gotten:19,group:12,guarante:[2,8],guarente:2,hand:16,handl:[6,8,10,14],handler:6,happen:[2,7,10,11],hard:14,hasn:10,have:[2,12,14,17],haven:10,header:[],heartbeat:[],heartbeat_timeout:10,heartbeati:14,heartbeatmixin:14,heavi:8,help:12,helper:14,here:[8,10],highest:12,hit:14,hope:8,how:[2,7],html:8,http:8,ident:[8,15],identifi:10,ietf:8,ignor:[8,14],immedi:[2,8],immediatli:2,implement:[8,14],impli:8,import_set:18,includ:[2,8,14],index:[5,10,16],indexerror:10,indiviud:12,inform:[2,6,8,10,14],inherit:4,ini:[12,18],initi:[2,14],insert:[8,14],instal:3,instanc:6,instanti:[2,6],instead:8,integ:10,intens:12,interest:16,intern:4,interpret:8,interv:[2,8,19],interval_sec:[2,19],intervalit:19,invalidmessageerror:[4,10],is_dead:14,is_empti:14,is_ful:14,is_heartbeat_en:14,is_pful:14,isn:[10,14],issu:[3,5,8],item:14,iter:[7,10,14],iterat:14,itself:10,job:[],job_lat:10,job_schedul:2,jobmanag:[],jobmanager_main:6,json:2,keep:[6,10],kei:[7,8,10],kick:[6,10],know:[2,6,10],kwarg2:2,kwarg:[2,6,7,9,10,11,14],larg:12,larger:12,largest:10,last:[2,10,14],last_recv_heartbeat:10,lataneci:10,latenc:10,later:8,least:[8,14],leav:[8,12],left:14,length:[14,16],lesser:8,let:8,like:[6,14,16],limit:14,list:[2,4,6,8,10,12,14,16,19],listen:[6,9,10,11,12,14],load:12,local:12,locat:2,log:[2,6,10],logic:[6,10],longer:[4,12],look:14,loop:[7,10,14],lot:12,lower:10,mai:[8,10,14],main:6,make:16,malform:4,manag:[],mani:[2,8,11],manual:8,master:8,match:14,measur:10,member:10,memebership:10,merchant:8,mess:19,messag:[],message_bodi:17,message_id:17,messageerror:4,met:14,meta:[10,17],method:[2,6,7,10,14],minut:2,model:12,modifi:8,modul:[1,5,6,16],monoton:[10,14,19],more:[2,8,14,16],most:14,mp_init:6,msg:[6,8,10,14,17],msgid:[6,10,14],multipart:[8,14],multiprocess:[6,12],must:[2,8,14],name:[2,6,8,9,10,11,12,18],need:[6,10,11],never:[6,19],next:[7,10,12,19],noavailableworkerslotserror:[4,10],nohast:8,none:[2,6,9,10,11,14,15,17],noop:6,normal:14,note:[6,9,11],notifi:14,now:14,number:[2,10,12,19],numer:19,obj:10,object:[7,14,16,19],occur:14,off:[6,10],on_ack:14,on_command:[10,14],on_disconnect:10,on_emqp_command:14,on_ful:14,on_heartbeat:[6,10],on_inform:10,on_readi:10,on_recv:9,on_repli:10,on_request:[6,10],on_schedul:14,onc:8,onlin:[10,14],option:[2,6,8,9,11,17],order:10,org:8,orient:8,origin:8,original_msg:10,other:[2,8,12],otherwis:[6,9,11,14],out:[6,14],outgo:[6,14],own:14,page:5,param:2,paramet:[2,6,7,9,10,11,14,15,16,17,18,19],pars:[10,14,17],parse_messag:17,parse_router_messag:17,part:[8,17],particular:[8,11],pass:[2,8,9,14],path:[2,4,6],payload:17,peek:14,peekleft:14,peer:[4,8,14],peergoneawayerror:[4,10],pend:8,per:10,pfull:14,pictur:8,placehold:[6,10],point:12,poll:7,poller:[],pollin:7,pollout:7,pool:[8,10],pop:[10,14],popleft:14,port:10,portion:6,possibl:3,practic:14,prefix:[15,17],prepar:10,prepend:8,pretti:[8,12],priorit:10,prioriti:10,prioritiess:10,prioritize_queue_list:10,problem:4,process:[6,8,10,11,12,14],process_client_messag:10,process_messag:[6,14],process_worker_messag:10,programm:14,proper:14,properti:[9,11,14],protocol:[],protocol_vers:14,provid:[10,14],pub:8,publish:8,purpos:8,push_notif:14,py2:19,py3:19,python3:15,python:[6,14],queue:[],queue_nam:10,rais:[2,4,9,10,11,14,17],random:[16,17],random_charact:16,raw:14,readi:[6,8,9,10,11,12,14],rebind:10,rebuild:11,rebuilt:6,receiv:[],received_disconnect:10,recent:[8,10],recipi:[6,10,14,17],recipient_id:17,recommend:[8,12,14],reconnect:11,recurs:[10,16],recus:10,recv:14,recv_multipart:14,redistribut:8,refer:[6,8,14,19],regist:[6,7,10],regular:8,reject:14,rel:3,reliabl:8,reload:10,remain:7,remot:14,remov:[8,10,14],reopen:14,rep:9,repli:[2,6,8,10,17],reply_request:2,repres:19,req:11,request:[1,2,6,8,10,14],requeue_work:10,requir:8,reset:[10,14],reset_heartbeat_count:[10,14],resourc:[6,8],respond:[8,10,14],respons:[6,9,10,11],restart:[8,11],retri:[2,8,10],retry_count:2,rfc2119:8,rfc:8,right:14,robin:8,roughli:11,round:8,rout:[8,10],router:[],router_main:10,run:[2,6,8,10,12,14],safe:12,sake:19,same:[11,16],schedul:[],scheduler_id:10,scheduler_queu:10,scheduler_zmq_id:10,search:5,sec:2,second:[2,19],seconds_until:19,section:18,see:[2,7,8,10,14],self:[6,10,11,14],semi:12,send:[2,4,6,8,10,11,14,17],send_ack:10,send_emqp_messag:17,send_emqp_router_messag:17,send_heartbeat:[10,14],send_inform:14,send_multipart:14,send_readi:6,send_repli:6,send_request:2,send_schedule_request:2,send_schedulers_heartbeat:10,send_workers_heartbeat:10,sender:[],sender_id:17,sent:[2,6,8,10,12,14],seper:[2,8,12],serial:10,serializ:2,serv:8,server:[6,8,12],servic:[8,14],service_typ:14,set:[],shall:8,should:[2,4,7,8,9,10,11,12,14,17],shown:8,sighup:10,sighup_handl:10,signal:6,signum:10,similar:12,simpl:[10,16],sinc:19,singl:[8,14],size:14,skip:[11,14],skip_sign:6,skip_zmqstream:11,slot:10,slow:12,smaller:12,socket:[2,6,7,8,9,10,11,14,15,17],softwar:8,some:[2,6,12,14,16,17],someon:8,someth:[2,11,12,14,19],somewher:3,sort:16,sourc:[3,5],spawn:6,specif:[],specifi:[8,14,16],standard:12,start:[6,9,10,11,12,14,19],start_valu:19,state:[10,14],statu:8,still:[10,12],stop:8,store:10,str:[2,6,9,10,11,14,15,16,17,18],string:[2,8,9,10,11,14,15,17],structur:4,style:12,sub:8,subclass:4,subcmd:6,subcommand:[2,6],subject:8,subset:8,subtract:19,success:8,successfulli:14,support:14,system:[3,10],take:[10,11,14,15,17],task:[2,6],tcp:10,tell:6,term:8,termin:6,test:6,thei:[2,14],them:9,thi:[1,2,4,6,7,8,9,10,11,12,14,15,16,17,19],thier:12,thing:[2,6,11,12,14,16,17],those:6,thread:12,threshold:14,through:[8,10],time:[],timeout:7,timestamp:[8,10,19],timeutil:[],tip:3,tool:8,topic:8,trace:8,track:[6,10,14],tri:2,tune:12,tupl:[6,7,10,14,16,17],tuplifi:16,type:[2,8,9,10,11,14,16,17],type_:14,typecast:7,typeerror:[2,9],unabl:10,unbind:[9,11],undefin:7,under:8,unicod:15,uniqu:[6,8,10],unit:6,unix:8,unknownqueueerror:[4,10],unless:[6,9,11],unprioritized_iter:10,unregist:7,unschedul:[2,8],until:[12,19],untouch:[10,17],unus:8,updat:14,upon:8,upstream:6,usag:19,usual:[14,19],util:[],utilit:[],utlitii:14,uuid:[6,9,10,11],valid:8,valu:[2,7,8,10,14,16,17,19],valueerror:14,variabl:14,version:[3,8,14],via:[2,19],wait:[2,7,12],waiting_messag:10,walk:6,want:[8,12,14],warn:10,warranti:8,weak:[14,19],web:8,weight:[8,12,14],well:8,when:[1,2,3,4,6,8,9,10,11,14,15,16],where:[2,8,10,14,19],which:[8,10,14,15],who:[1,10],wish:17,without:[6,8,11],word:8,work:[3,6,14],worker:[],worker_id:10,worri:8,would:[12,14,19],wrap:2,wrapper:2,you:[3,8,10,11,12,14,17],your:[2,8,12,14],zcontext:[9,11],zero_index_cmp:16,zeromq:8,zmq:[7,8,9,10,11,14,15,17],zmqreceivemixin:14,zmqsendmixin:14,zmqstream:11,zsocket:[9,11]},titles:["API Documentation","<code class=\"docutils literal\"><span class=\"pre\">client</span></code> &#8211; Client Utilities","<code class=\"docutils literal\"><span class=\"pre\">messages</span></code> &#8211; Client Messaging","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","<code class=\"docutils literal\"><span class=\"pre\">poller</span></code> &#8211; Poller","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","Settings","Using EventMQ","<code class=\"docutils literal\"><span class=\"pre\">classes</span></code> &#8211; Utility Classes","<code class=\"docutils literal\"><span class=\"pre\">devices</span></code> &#8211; Device Utilities","<code class=\"docutils literal\"><span class=\"pre\">utils</span></code> &#8211; Utilities","<code class=\"docutils literal\"><span class=\"pre\">messages</span></code> &#8211; Message Utilities","<code class=\"docutils literal\"><span class=\"pre\">settings</span></code> &#8211; Settings Utilities","<code class=\"docutils literal\"><span class=\"pre\">timeutils</span></code> &#8211; Time Utilites"],titleterms:{"class":14,address:8,api:0,architectur:8,client:[1,2,8],concurrent_job:12,contribut:3,devic:15,disconnect:8,document:[0,5],emqp:8,eventmq:[3,5,8,13],except:4,frame:8,global:8,goal:8,header:8,heartbeat:8,indic:5,job:[6,12],jobmanag:6,kbai:8,languag:8,licens:8,manag:[6,12],messag:[2,17],poller:7,protocol:8,queue:12,receiv:9,router:[8,10,12],schedul:[8,12],sender:11,set:[12,18],specif:8,tabl:5,time:19,timeutil:19,topolog:8,util:[1,14,15,16,17,18],utilit:19,worker:8}}) \ No newline at end of file
diff --git a/sender.html b/sender.html
index 976d996..30a722f 100644
--- a/sender.html
+++ b/sender.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="up" title="API Documentation" href="api.html"/> 34 <link rel="up" title="API Documentation" href="api.html"/>
38 <link rel="next" title="utils – Utilities" href="utils/index.html"/> 35 <link rel="next" title="utils – Utilities" href="utils/index.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -94,7 +91,7 @@
94<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li> 91<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li>
95<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> 92<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>
96<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> 93<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>
97<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 94<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
98<li class="toctree-l2"><a class="reference internal" href="utils/index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li> 95<li class="toctree-l2"><a class="reference internal" href="utils/index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
99</ul> 96</ul>
100</li> 97</li>
@@ -121,7 +118,7 @@
121 <div class="rst-content"> 118 <div class="rst-content">
122 119
123 120
124 121
125 122
126 123
127 124
@@ -155,19 +152,21 @@
155<dl class="attribute"> 152<dl class="attribute">
156<dt id="eventmq.sender.Sender.name"> 153<dt id="eventmq.sender.Sender.name">
157<code class="descname">name</code><a class="headerlink" href="#eventmq.sender.Sender.name" title="Permalink to this definition">¶</a></dt> 154<code class="descname">name</code><a class="headerlink" href="#eventmq.sender.Sender.name" title="Permalink to this definition">¶</a></dt>
158<dd><p><em>str</em> &#8211; Name of this socket</p> 155<dd><p><em>str</em></p>
156<p>Name of this socket</p>
159</dd></dl> 157</dd></dl>
160 158
161<dl class="attribute"> 159<dl class="attribute">
162<dt id="eventmq.sender.Sender.zcontext"> 160<dt id="eventmq.sender.Sender.zcontext">
163<code class="descname">zcontext</code><a class="headerlink" href="#eventmq.sender.Sender.zcontext" title="Permalink to this definition">¶</a></dt> 161<code class="descname">zcontext</code><a class="headerlink" href="#eventmq.sender.Sender.zcontext" title="Permalink to this definition">¶</a></dt>
164<dd><p><a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a> &#8211; socket context</p> 162<dd><p><a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a></p>
163<p>socket context</p>
165</dd></dl> 164</dd></dl>
166 165
167<dl class="attribute"> 166<dl class="attribute">
168<dt id="eventmq.sender.Sender.zsocket"> 167<dt id="eventmq.sender.Sender.zsocket">
169<code class="descname">zsocket</code><a class="headerlink" href="#eventmq.sender.Sender.zsocket" title="Permalink to this definition">¶</a></dt> 168<code class="descname">zsocket</code><a class="headerlink" href="#eventmq.sender.Sender.zsocket" title="Permalink to this definition">¶</a></dt>
170<dd><p><a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a></p> 169<dd><p><a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a></p>
171</dd></dl> 170</dd></dl>
172 171
173<dl class="method"> 172<dl class="method">
@@ -182,13 +181,13 @@
182<col class="field-body" /> 181<col class="field-body" />
183<tbody valign="top"> 182<tbody valign="top">
184<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 183<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
185<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of this socket. By default a uuid will be 184<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of this socket. By default a uuid will be
186generated</li> 185generated</li>
187<li><strong>context</strong> (<a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a>) &#8211; Context to use when building the 186<li><strong>context</strong> (<a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a>) &#8211; Context to use when building the
188socket</li> 187socket</li>
189<li><strong>socket</strong> (<a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a>) &#8211; Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REQ</span></code> or 188<li><strong>socket</strong> (<a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a>) &#8211; Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REQ</span></code> or
190<code class="xref py py-attr docutils literal"><span class="pre">zmq.DEALER</span></code>. By default a <cite>DEALER</cite> is used</li> 189<code class="xref py py-attr docutils literal"><span class="pre">zmq.DEALER</span></code>. By default a <cite>DEALER</cite> is used</li>
191<li><strong>skip_zmqstream</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; If set to true, skip creating the zmqstream 190<li><strong>skip_zmqstream</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; If set to true, skip creating the zmqstream
192socket</li> 191socket</li>
193</ul> 192</ul>
194</td> 193</td>
@@ -205,9 +204,10 @@ socket</li>
205<col class="field-name" /> 204<col class="field-name" />
206<col class="field-body" /> 205<col class="field-body" />
207<tbody valign="top"> 206<tbody valign="top">
208<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to connect to as a connection string</td> 207<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to connect to as a connection string</td>
209</tr> 208</tr>
210<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></td> 209<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">:class</span></code> &#8211;
210<cite>Exception</cite></td>
211</tr> 211</tr>
212</tbody> 212</tbody>
213</table> 213</table>
@@ -221,9 +221,10 @@ socket</li>
221<col class="field-name" /> 221<col class="field-name" />
222<col class="field-body" /> 222<col class="field-body" />
223<tbody valign="top"> 223<tbody valign="top">
224<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to listen on as a connction string</td> 224<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to listen on as a connction string</td>
225</tr> 225</tr>
226<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></td> 226<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">:class</span></code> &#8211;
227<cite>Exception</cite></td>
227</tr> 228</tr>
228</tbody> 229</tbody>
229</table> 230</table>
@@ -237,13 +238,10 @@ socket</li>
237<col class="field-name" /> 238<col class="field-name" />
238<col class="field-body" /> 239<col class="field-body" />
239<tbody valign="top"> 240<tbody valign="top">
240<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> 241<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the receiver is ready to connect or listen, otherwise
241<dt>True if the receiver is ready to connect or listen, otherwise</dt> 242False</td>
242<dd>False</dd>
243</dl>
244</td>
245</tr> 243</tr>
246<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 244<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
247</tr> 245</tr>
248</tbody> 246</tbody>
249</table> 247</table>
@@ -261,9 +259,9 @@ parameters as <code class="xref py py-meth docutils literal"><span class="pre">s
261<col class="field-body" /> 259<col class="field-body" />
262<tbody valign="top"> 260<tbody valign="top">
263<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 261<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
264<li><strong>socket</strong> (<a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a>) &#8211; Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REQ</span></code> or 262<li><strong>socket</strong> (<a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a>) &#8211; Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REQ</span></code> or
265<code class="xref py py-attr docutils literal"><span class="pre">zmq.DEALER</span></code>. By default a <cite>DEALER</cite> is used</li> 263<code class="xref py py-attr docutils literal"><span class="pre">zmq.DEALER</span></code>. By default a <cite>DEALER</cite> is used</li>
266<li><strong>skip_zmqstream</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; If set to true, skip creating the zmqstream 264<li><strong>skip_zmqstream</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; If set to true, skip creating the zmqstream
267socket</li> 265socket</li>
268</ul> 266</ul>
269</td> 267</td>
@@ -280,9 +278,10 @@ socket</li>
280<col class="field-name" /> 278<col class="field-name" />
281<col class="field-body" /> 279<col class="field-body" />
282<tbody valign="top"> 280<tbody valign="top">
283<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to unbind from as a string</td> 281<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address to unbind from as a string</td>
284</tr> 282</tr>
285<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></td> 283<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">:class</span></code> &#8211;
284<cite>Exception</cite></td>
286</tr> 285</tr>
287</tbody> 286</tbody>
288</table> 287</table>
diff --git a/settings_file.html b/settings_file.html
index 9133384..c351b42 100644
--- a/settings_file.html
+++ b/settings_file.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="up" title="Using EventMQ" href="using.html"/> 34 <link rel="up" title="Using EventMQ" href="using.html"/>
38 <link rel="next" title="API Documentation" href="api.html"/> 35 <link rel="next" title="API Documentation" href="api.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -87,7 +84,7 @@
87 84
88 <ul class="current"> 85 <ul class="current">
89<li class="toctree-l1 current"><a class="reference internal" href="using.html">Using EventMQ</a><ul class="current"> 86<li class="toctree-l1 current"><a class="reference internal" href="using.html">Using EventMQ</a><ul class="current">
90<li class="toctree-l2 current"><a class="current reference internal" href="#">Settings</a><ul> 87<li class="toctree-l2 current"><a class="current reference internal" href="">Settings</a><ul>
91<li class="toctree-l3"><a class="reference internal" href="#router">Router</a></li> 88<li class="toctree-l3"><a class="reference internal" href="#router">Router</a></li>
92<li class="toctree-l3"><a class="reference internal" href="#scheduler">Scheduler</a></li> 89<li class="toctree-l3"><a class="reference internal" href="#scheduler">Scheduler</a></li>
93<li class="toctree-l3"><a class="reference internal" href="#job-manager">Job Manager</a><ul> 90<li class="toctree-l3"><a class="reference internal" href="#job-manager">Job Manager</a><ul>
@@ -123,7 +120,7 @@
123 <div class="rst-content"> 120 <div class="rst-content">
124 121
125 122
126 123
127 124
128 125
129 126
diff --git a/using.html b/using.html
index b766ac3..8a37399 100644
--- a/using.html
+++ b/using.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
37 <link rel="next" title="Settings" href="settings_file.html"/> 34 <link rel="next" title="Settings" href="settings_file.html"/>
38 <link rel="prev" title="EventMQ Documentation" href="index.html"/> 35 <link rel="prev" title="EventMQ Documentation" href="index.html"/>
@@ -63,7 +60,7 @@
63 60
64 61
65 <div class="version"> 62 <div class="version">
66 0.2.6.3 63 0.2.6.5
67 </div> 64 </div>
68 65
69 66
@@ -85,7 +82,7 @@
85 82
86 83
87 <ul class="current"> 84 <ul class="current">
88<li class="toctree-l1 current"><a class="current reference internal" href="#">Using EventMQ</a><ul> 85<li class="toctree-l1 current"><a class="current reference internal" href="">Using EventMQ</a><ul>
89<li class="toctree-l2"><a class="reference internal" href="settings_file.html">Settings</a></li> 86<li class="toctree-l2"><a class="reference internal" href="settings_file.html">Settings</a></li>
90</ul> 87</ul>
91</li> 88</li>
@@ -113,7 +110,7 @@
113 <div class="rst-content"> 110 <div class="rst-content">
114 111
115 112
116 113
117 114
118 115
119 116
diff --git a/utils/classes.html b/utils/classes.html
index 9f055f2..4e1ae6d 100644
--- a/utils/classes.html
+++ b/utils/classes.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
37 <link rel="up" title="utils – Utilities" href="index.html"/> 34 <link rel="up" title="utils – Utilities" href="index.html"/>
38 <link rel="next" title="devices – Device Utilities" href="devices.html"/> 35 <link rel="next" title="devices – Device Utilities" href="devices.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -96,7 +93,7 @@
96<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> 93<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>
97<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> 94<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>
98<li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current"> 95<li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current">
99<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li> 96<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li>
100<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li> 97<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li>
101<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 98<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li>
102<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li> 99<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li>
@@ -128,7 +125,7 @@
128 <div class="rst-content"> 125 <div class="rst-content">
129 126
130 127
131 128
132 129
133 130
134 131
@@ -238,8 +235,8 @@ for.</p>
238<col class="field-body" /> 235<col class="field-body" />
239<tbody valign="top"> 236<tbody valign="top">
240<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 237<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
241<li><strong>type</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Either &#8216;worker&#8217; or &#8216;scheduler&#8217;</li> 238<li><strong>type</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Either &#8216;worker&#8217; or &#8216;scheduler&#8217;</li>
242<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; <ul> 239<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; <ul>
243<li>For &#8216;worker&#8217; type, the queues the worker is listening on and 240<li>For &#8216;worker&#8217; type, the queues the worker is listening on and
244their weights.<dl class="docutils"> 241their weights.<dl class="docutils">
245<dt>Example:</dt> 242<dt>Example:</dt>
@@ -252,13 +249,14 @@ their weights.<dl class="docutils">
252</ul> 249</ul>
253</td> 250</td>
254</tr> 251</tr>
255<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> &#8211; When <cite>type_</cite> does not match a specified type</p> 252<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> &#8211;
253When <cite>type_</cite> does not match a specified type</p>
256</td> 254</td>
257</tr> 255</tr>
258<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> 256<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p>
259</td> 257</td>
260</tr> 258</tr>
261<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p> 259<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></p>
262</td> 260</td>
263</tr> 261</tr>
264</tbody> 262</tbody>
@@ -278,7 +276,7 @@ compatibility and not recommended for new apps.</p>
278<col class="field-name" /> 276<col class="field-name" />
279<col class="field-body" /> 277<col class="field-body" />
280<tbody valign="top"> 278<tbody valign="top">
281<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to connect to</td> 279<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to connect to</td>
282</tr> 280</tr>
283</tbody> 281</tbody>
284</table> 282</table>
@@ -305,12 +303,12 @@ checked to ensure proper error handling.</p>
305<col class="field-body" /> 303<col class="field-body" />
306<tbody valign="top"> 304<tbody valign="top">
307<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 305<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
308<li><strong>full</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Hard limit on deque size. Rejects adding elements. 306<li><strong>full</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Hard limit on deque size. Rejects adding elements.
309Default: 0 - no limit</li> 307Default: 0 - no limit</li>
310<li><strong>pfull</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Programmable limit on deque size, defaults 308<li><strong>pfull</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Programmable limit on deque size, defaults
311to <code class="docutils literal"><span class="pre">full</span></code> length</li> 309to <code class="docutils literal"><span class="pre">full</span></code> length</li>
312<li><strong>on_full</strong> (<em>func</em>) &#8211; callback to call when <code class="docutils literal"><span class="pre">full</span></code> limit is hit</li> 310<li><strong>on_full</strong> (<em>func</em>) &#8211; callback to call when <code class="docutils literal"><span class="pre">full</span></code> limit is hit</li>
313<li><strong>initial</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#iter" title="(in Python v2.7)"><em>iter</em></a>) &#8211; The initial iteratable used to contruct the deque</li> 311<li><strong>initial</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#iter" title="(in Python v2.7)"><em>iter</em></a>) &#8211; The initial iteratable used to contruct the deque</li>
314</ul> 312</ul>
315</td> 313</td>
316</tr> 314</tr>
@@ -337,14 +335,11 @@ where False is returned.</p>
337<col class="field-name" /> 335<col class="field-name" />
338<col class="field-body" /> 336<col class="field-body" />
339<tbody valign="top"> 337<tbody valign="top">
340<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> 338<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque
341<dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> 339is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is
342<dd>is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is 340called.</td>
343called.</dd>
344</dl>
345</td>
346</tr> 341</tr>
347<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 342<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
348</tr> 343</tr>
349</tbody> 344</tbody>
350</table> 345</table>
@@ -363,14 +358,11 @@ where False is returned.</p>
363<col class="field-name" /> 358<col class="field-name" />
364<col class="field-body" /> 359<col class="field-body" />
365<tbody valign="top"> 360<tbody valign="top">
366<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> 361<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque
367<dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> 362is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is
368<dd>is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is 363called.</td>
369called.</dd>
370</dl>
371</td>
372</tr> 364</tr>
373<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 365<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
374</tr> 366</tr>
375</tbody> 367</tbody>
376</table> 368</table>
@@ -384,14 +376,11 @@ called.</dd>
384<col class="field-name" /> 376<col class="field-name" />
385<col class="field-body" /> 377<col class="field-body" />
386<tbody valign="top"> 378<tbody valign="top">
387<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> 379<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque
388<dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> 380is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is
389<dd>is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is 381called.</td>
390called.</dd>
391</dl>
392</td>
393</tr> 382</tr>
394<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 383<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
395</tr> 384</tr>
396</tbody> 385</tbody>
397</table> 386</table>
@@ -407,7 +396,7 @@ called.</dd>
407<tbody valign="top"> 396<tbody valign="top">
408<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains 0 items. False otherwise</td> 397<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains 0 items. False otherwise</td>
409</tr> 398</tr>
410<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 399<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
411</tr> 400</tr>
412</tbody> 401</tbody>
413</table> 402</table>
@@ -424,7 +413,7 @@ called.</dd>
424<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">full</span></code> items. False 413<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">full</span></code> items. False
425otherwise</td> 414otherwise</td>
426</tr> 415</tr>
427<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 416<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
428</tr> 417</tr>
429</tbody> 418</tbody>
430</table> 419</table>
@@ -441,7 +430,37 @@ otherwise</td>
441<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">pfull</span></code> items. 430<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">pfull</span></code> items.
442False otherwise</td> 431False otherwise</td>
443</tr> 432</tr>
444<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 433<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
434</tr>
435</tbody>
436</table>
437</dd></dl>
438
439<dl class="method">
440<dt id="eventmq.utils.classes.EMQdeque.peek">
441<code class="descname">peek</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.peek" title="Permalink to this definition">¶</a></dt>
442<dd><table class="docutils field-list" frame="void" rules="none">
443<col class="field-name" />
444<col class="field-body" />
445<tbody valign="top">
446<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td>
447</tr>
448<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)">object</a></td>
449</tr>
450</tbody>
451</table>
452</dd></dl>
453
454<dl class="method">
455<dt id="eventmq.utils.classes.EMQdeque.peekleft">
456<code class="descname">peekleft</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.peekleft" title="Permalink to this definition">¶</a></dt>
457<dd><table class="docutils field-list" frame="void" rules="none">
458<col class="field-name" />
459<col class="field-body" />
460<tbody valign="top">
461<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td>
462</tr>
463<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)">object</a></td>
445</tr> 464</tr>
446</tbody> 465</tbody>
447</table> 466</table>
@@ -456,7 +475,7 @@ False otherwise</td>
456<tbody valign="top"> 475<tbody valign="top">
457<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td> 476<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td>
458</tr> 477</tr>
459<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)">object</a></td> 478<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)">object</a></td>
460</tr> 479</tr>
461</tbody> 480</tbody>
462</table> 481</table>
@@ -471,7 +490,7 @@ False otherwise</td>
471<tbody valign="top"> 490<tbody valign="top">
472<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td> 491<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td>
473</tr> 492</tr>
474<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)">object</a></td> 493<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)">object</a></td>
475</tr> 494</tr>
476</tbody> 495</tbody>
477</table> 496</table>
@@ -485,7 +504,7 @@ False otherwise</td>
485<col class="field-name" /> 504<col class="field-name" />
486<col class="field-body" /> 505<col class="field-body" />
487<tbody valign="top"> 506<tbody valign="top">
488<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; The item to remove from the deque</td> 507<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; The item to remove from the deque</td>
489</tr> 508</tr>
490</tbody> 509</tbody>
491</table> 510</table>
@@ -518,17 +537,14 @@ met.</p>
518<col class="field-name" /> 537<col class="field-name" />
519<col class="field-body" /> 538<col class="field-body" />
520<tbody valign="top"> 539<tbody valign="top">
521<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>now</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) &#8211; The time to use to check if death has occurred. If 540<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>now</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) &#8211; The time to use to check if death has occurred. If
522this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code> 541this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code>
523is used.</td> 542is used.</td>
524</tr> 543</tr>
525<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> 544<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the connection to the peer has died, otherwise
526<dt>True if the connection to the peer has died, otherwise</dt> 545False</td>
527<dd>False</dd>
528</dl>
529</td>
530</tr> 546</tr>
531<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 547<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
532</tr> 548</tr>
533</tbody> 549</tbody>
534</table> 550</table>
@@ -548,11 +564,11 @@ is used.</td>
548<col class="field-name" /> 564<col class="field-name" />
549<col class="field-body" /> 565<col class="field-body" />
550<tbody valign="top"> 566<tbody valign="top">
551<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The eMQP socket to send the message to</td> 567<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The eMQP socket to send the message to</td>
552</tr> 568</tr>
553<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td> 569<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td>
554</tr> 570</tr>
555<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td> 571<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></td>
556</tr> 572</tr>
557</tbody> 573</tbody>
558</table> 574</table>
@@ -606,7 +622,7 @@ on it&#8217;s own</p>
606<tbody valign="top"> 622<tbody valign="top">
607<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 623<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
608<li><strong>message</strong> &#8211; message to send to something</li> 624<li><strong>message</strong> &#8211; message to send to something</li>
609<li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; protocol version. it&#8217;s good practice, but 625<li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; protocol version. it&#8217;s good practice, but
610you may explicitly specify None to skip adding the version</li> 626you may explicitly specify None to skip adding the version</li>
611</ul> 627</ul>
612</td> 628</td>
@@ -628,10 +644,10 @@ like this</p>
628<col class="field-body" /> 644<col class="field-body" />
629<tbody valign="top"> 645<tbody valign="top">
630<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 646<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
631<li><strong>message</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; Raw message to send.</li> 647<li><strong>message</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; Raw message to send.</li>
632<li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; protocol version. it&#8217;s good practice but 648<li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; protocol version. it&#8217;s good practice but
633you may explicitly specify None to skip adding the version</li> 649you may explicitly specify None to skip adding the version</li>
634<li><strong>_recipient_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; When using a <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code> you must 650<li><strong>_recipient_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; When using a <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code> you must
635specify the the recipient id of the remote socket</li> 651specify the the recipient id of the remote socket</li>
636</ul> 652</ul>
637</td> 653</td>
diff --git a/utils/devices.html b/utils/devices.html
index bd246de..a315fcf 100644
--- a/utils/devices.html
+++ b/utils/devices.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
37 <link rel="up" title="utils – Utilities" href="index.html"/> 34 <link rel="up" title="utils – Utilities" href="index.html"/>
38 <link rel="next" title="messages – Message Utilities" href="messages.html"/> 35 <link rel="next" title="messages – Message Utilities" href="messages.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -97,7 +94,7 @@
97<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> 94<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>
98<li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current"> 95<li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current">
99<li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li> 96<li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li>
100<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li> 97<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li>
101<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 98<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li>
102<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li> 99<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li>
103<li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li> 100<li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li>
@@ -128,7 +125,7 @@
128 <div class="rst-content"> 125 <div class="rst-content">
129 126
130 127
131 128
132 129
133 130
134 131
@@ -165,7 +162,7 @@ causes errors when setting the IDENTITY of the ZMQ socket.</p>
165<col class="field-name" /> 162<col class="field-name" />
166<col class="field-body" /> 163<col class="field-body" />
167<tbody valign="top"> 164<tbody valign="top">
168<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Prefix the id with this string.</td> 165<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Prefix the id with this string.</td>
169</tr> 166</tr>
170</tbody> 167</tbody>
171</table> 168</table>
diff --git a/utils/index.html b/utils/index.html
index 386ef87..984c206 100644
--- a/utils/index.html
+++ b/utils/index.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
37 <link rel="up" title="API Documentation" href="../api.html"/> 34 <link rel="up" title="API Documentation" href="../api.html"/>
38 <link rel="next" title="classes – Utility Classes" href="classes.html"/> 35 <link rel="next" title="classes – Utility Classes" href="classes.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -95,7 +92,7 @@
95<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> 92<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>
96<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> 93<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>
97<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> 94<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>
98<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul> 95<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul>
99<li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li> 96<li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li>
100<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li> 97<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li>
101<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 98<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li>
@@ -128,7 +125,7 @@
128 <div class="rst-content"> 125 <div class="rst-content">
129 126
130 127
131 128
132 129
133 130
134 131
@@ -174,7 +171,7 @@ like creating message more simple.</p>
174<tbody valign="top"> 171<tbody valign="top">
175<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">some random characters of a specified length</td> 172<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">some random characters of a specified length</td>
176</tr> 173</tr>
177<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td> 174<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></td>
178</tr> 175</tr>
179</tbody> 176</tbody>
180</table> 177</table>
@@ -188,7 +185,7 @@ like creating message more simple.</p>
188<col class="field-name" /> 185<col class="field-name" />
189<col class="field-body" /> 186<col class="field-body" />
190<tbody valign="top"> 187<tbody valign="top">
191<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>v</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; any value of interest</td> 188<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>v</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; any value of interest</td>
192</tr> 189</tr>
193</tbody> 190</tbody>
194</table> 191</table>
diff --git a/utils/messages.html b/utils/messages.html
index 8c09dc5..52b1357 100644
--- a/utils/messages.html
+++ b/utils/messages.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
37 <link rel="up" title="utils – Utilities" href="index.html"/> 34 <link rel="up" title="utils – Utilities" href="index.html"/>
38 <link rel="next" title="settings – Settings Utilities" href="settings.html"/> 35 <link rel="next" title="settings – Settings Utilities" href="settings.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -98,7 +95,7 @@
98<li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current"> 95<li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current">
99<li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li> 96<li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li>
100<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li> 97<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li>
101<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 98<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li>
102<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li> 99<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li>
103<li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li> 100<li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li>
104</ul> 101</ul>
@@ -128,7 +125,7 @@
128 <div class="rst-content"> 125 <div class="rst-content">
129 126
130 127
131 128
132 129
133 130
134 131
@@ -166,8 +163,8 @@
166<tbody valign="top"> 163<tbody valign="top">
167<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 164<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
168<li><strong>socket</strong> &#8211; socket to send the message with</li> 165<li><strong>socket</strong> &#8211; socket to send the message with</li>
169<li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the id of the connected device to reply to</li> 166<li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the id of the connected device to reply to</li>
170<li><strong>payload</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; The message to send. The first frame should be an 167<li><strong>payload</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; The message to send. The first frame should be an
171empty string</li> 168empty string</li>
172</ul> 169</ul>
173</td> 170</td>
@@ -185,7 +182,7 @@ be prefixed with <cite>prefix</cite>.</p>
185<col class="field-name" /> 182<col class="field-name" />
186<col class="field-body" /> 183<col class="field-body" />
187<tbody valign="top"> 184<tbody valign="top">
188<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Value to prefix on to the random part of the id. Useful 185<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Value to prefix on to the random part of the id. Useful
189for prefixing some meta data to use for things</td> 186for prefixing some meta data to use for things</td>
190</tr> 187</tr>
191</tbody> 188</tbody>
@@ -248,7 +245,7 @@ parts.</p>
248<tbody valign="top"> 245<tbody valign="top">
249<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td> 246<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td>
250</tr> 247</tr>
251<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td> 248<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></td>
252</tr> 249</tr>
253</tbody> 250</tbody>
254</table> 251</table>
@@ -263,20 +260,22 @@ used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.R
263<col class="field-name" /> 260<col class="field-name" />
264<col class="field-body" /> 261<col class="field-body" />
265<tbody valign="top"> 262<tbody valign="top">
266<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 263<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
267<li><strong>socket</strong> &#8211; socket to send the message with</li> 264<li><strong>socket</strong> &#8211; socket to send the message with</li>
268<li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the id of the connected device to reply to</li> 265<li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the id of the connected device to reply to</li>
269<li><strong>command</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the eMQP command to send</li> 266<li><strong>command</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the eMQP command to send</li>
270<li><strong>message</strong> &#8211; a msg tuple to send</li> 267<li><strong>message</strong> &#8211; a msg tuple to send</li>
271</ul> 268</ul>
272</td> 269</td>
273</tr> 270</tr>
271<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Message id for this message</p>
272</td>
273</tr>
274<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></p>
275</td>
276</tr>
274</tbody> 277</tbody>
275</table> 278</table>
276<dl class="docutils">
277<dt>Returns</dt>
278<dd>str: Message id for this message</dd>
279</dl>
280</dd></dl> 279</dd></dl>
281 280
282</div> 281</div>
diff --git a/utils/settings.html b/utils/settings.html
index 0e4a7b4..d7fec22 100644
--- a/utils/settings.html
+++ b/utils/settings.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
37 <link rel="up" title="utils – Utilities" href="index.html"/> 34 <link rel="up" title="utils – Utilities" href="index.html"/>
38 <link rel="next" title="timeutils – Time Utilites" href="timeutils.html"/> 35 <link rel="next" title="timeutils – Time Utilites" href="timeutils.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -99,7 +96,7 @@
99<li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li> 96<li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li>
100<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li> 97<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li>
101<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 98<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li>
102<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li> 99<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li>
103<li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li> 100<li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li>
104</ul> 101</ul>
105</li> 102</li>
@@ -128,7 +125,7 @@
128 <div class="rst-content"> 125 <div class="rst-content">
129 126
130 127
131 128
132 129
133 130
134 131
@@ -164,7 +161,7 @@
164<col class="field-name" /> 161<col class="field-name" />
165<col class="field-body" /> 162<col class="field-body" />
166<tbody valign="top"> 163<tbody valign="top">
167<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>section</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the INI section to import</td> 164<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>section</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the INI section to import</td>
168</tr> 165</tr>
169</tbody> 166</tbody>
170</table> 167</table>
diff --git a/utils/timeutils.html b/utils/timeutils.html
index 388cac5..e395705 100644
--- a/utils/timeutils.html
+++ b/utils/timeutils.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
37 <link rel="up" title="utils – Utilities" href="index.html"/> 34 <link rel="up" title="utils – Utilities" href="index.html"/>
38 <link rel="next" title="Contributing to EventMQ" href="../contributing.html"/> 35 <link rel="next" title="Contributing to EventMQ" href="../contributing.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -100,7 +97,7 @@
100<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li> 97<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li>
101<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 98<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li>
102<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li> 99<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li>
103<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li> 100<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li>
104</ul> 101</ul>
105</li> 102</li>
106</ul> 103</ul>
@@ -128,7 +125,7 @@
128 <div class="rst-content"> 125 <div class="rst-content">
129 126
130 127
131 128
132 129
133 130
134 131
@@ -181,8 +178,8 @@ next(interval) # 600</p>
181<col class="field-body" /> 178<col class="field-body" />
182<tbody valign="top"> 179<tbody valign="top">
183<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 180<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
184<li><strong>start_value</strong> (<em>numeric</em>) &#8211; via <a class="reference internal" href="#eventmq.utils.timeutils.monotonic" title="eventmq.utils.timeutils.monotonic"><code class="xref py py-func docutils literal"><span class="pre">monotonic()</span></code></a> or <a class="reference internal" href="#eventmq.utils.timeutils.timestamp" title="eventmq.utils.timeutils.timestamp"><code class="xref py py-func docutils literal"><span class="pre">timestamp()</span></code></a></li> 181<li><strong>(numeric) - the timestamp to begin with. usually gotten</strong> (<em>start_value</em>) &#8211; via <a class="reference internal" href="#eventmq.utils.timeutils.monotonic" title="eventmq.utils.timeutils.monotonic"><code class="xref py py-func docutils literal"><span class="pre">monotonic()</span></code></a> or <a class="reference internal" href="#eventmq.utils.timeutils.timestamp" title="eventmq.utils.timeutils.timestamp"><code class="xref py py-func docutils literal"><span class="pre">timestamp()</span></code></a></li>
185<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; </li> 182<li><strong>(int) - the number of seconds between intervals</strong> (<em>interval_secs</em>) &#8211; </li>
186</ul> 183</ul>
187</td> 184</td>
188</tr> 185</tr>
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-12 03:00:38 +0000