diff options
| author | jason | 2016-10-04 11:58:36 -0600 |
|---|---|---|
| committer | jason | 2016-10-04 11:58:36 -0600 |
| commit | 02002cd2f9b3521f803e992dd4b6cabc9f0aea5d (patch) | |
| tree | e928f16315148cbbf22326f6e37372baa3e8ffe1 | |
| parent | 41b2025fe4e22689599ae1c2d7feb91b2e978d7e (diff) | |
| download | eventmq-02002cd2f9b3521f803e992dd4b6cabc9f0aea5d.tar.gz eventmq-02002cd2f9b3521f803e992dd4b6cabc9f0aea5d.zip | |
docs updates
| -rw-r--r-- | _static/basic.css | 22 | ||||
| -rw-r--r-- | _static/doctools.js | 28 | ||||
| -rw-r--r-- | _static/searchtools.js | 53 | ||||
| -rw-r--r-- | _static/websupport.js | 4 | ||||
| -rw-r--r-- | api.html | 9 | ||||
| -rw-r--r-- | client.html | 9 | ||||
| -rw-r--r-- | client/messages.html | 89 | ||||
| -rw-r--r-- | contributing.html | 9 | ||||
| -rw-r--r-- | exceptions.html | 11 | ||||
| -rw-r--r-- | genindex.html | 25 | ||||
| -rw-r--r-- | index.html | 13 | ||||
| -rw-r--r-- | jobmanager.html | 21 | ||||
| -rw-r--r-- | objects.inv | bin | 1419 -> 1752 bytes | |||
| -rw-r--r-- | poller.html | 23 | ||||
| -rw-r--r-- | protocol.html | 9 | ||||
| -rw-r--r-- | py-modindex.html | 35 | ||||
| -rw-r--r-- | receiver.html | 34 | ||||
| -rw-r--r-- | router.html | 37 | ||||
| -rw-r--r-- | search.html | 5 | ||||
| -rw-r--r-- | searchindex.js | 2 | ||||
| -rw-r--r-- | sender.html | 40 | ||||
| -rw-r--r-- | settings_file.html | 9 | ||||
| -rw-r--r-- | using.html | 9 | ||||
| -rw-r--r-- | utils/classes.html | 91 | ||||
| -rw-r--r-- | utils/devices.html | 11 | ||||
| -rw-r--r-- | utils/index.html | 13 | ||||
| -rw-r--r-- | utils/messages.html | 21 | ||||
| -rw-r--r-- | utils/settings.html | 11 | ||||
| -rw-r--r-- | utils/timeutils.html | 11 |
29 files changed, 408 insertions, 246 deletions
diff --git a/_static/basic.css b/_static/basic.css index 9fa77d8..0b79414 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-2015 by the Sphinx team, see AUTHORS. | 7 | * :copyright: Copyright 2007-2016 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,6 +52,8 @@ 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; | ||
| 55 | } | 57 | } |
| 56 | 58 | ||
| 57 | div.sphinxsidebar ul { | 59 | div.sphinxsidebar ul { |
| @@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] { | |||
| 83 | width: 170px; | 85 | width: 170px; |
| 84 | } | 86 | } |
| 85 | 87 | ||
| 86 | div.sphinxsidebar #searchbox input[type="submit"] { | ||
| 87 | width: 30px; | ||
| 88 | } | ||
| 89 | |||
| 90 | img { | 88 | img { |
| 91 | border: 0; | 89 | border: 0; |
| 92 | max-width: 100%; | 90 | max-width: 100%; |
| @@ -187,6 +185,13 @@ div.genindex-jumpbox { | |||
| 187 | 185 | ||
| 188 | /* -- general body styles --------------------------------------------------- */ | 186 | /* -- general body styles --------------------------------------------------- */ |
| 189 | 187 | ||
| 188 | div.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 | |||
| 190 | a.headerlink { | 195 | a.headerlink { |
| 191 | visibility: hidden; | 196 | visibility: hidden; |
| 192 | } | 197 | } |
| @@ -489,6 +494,13 @@ pre { | |||
| 489 | overflow-y: hidden; /* fixes display issues on Chrome browsers */ | 494 | overflow-y: hidden; /* fixes display issues on Chrome browsers */ |
| 490 | } | 495 | } |
| 491 | 496 | ||
| 497 | span.pre { | ||
| 498 | -moz-hyphens: none; | ||
| 499 | -ms-hyphens: none; | ||
| 500 | -webkit-hyphens: none; | ||
| 501 | hyphens: none; | ||
| 502 | } | ||
| 503 | |||
| 492 | td.linenos pre { | 504 | td.linenos pre { |
| 493 | padding: 5px 0px; | 505 | padding: 5px 0px; |
| 494 | border: 0; | 506 | border: 0; |
diff --git a/_static/doctools.js b/_static/doctools.js index c7bfe76..8163495 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-2015 by the Sphinx team, see AUTHORS. | 7 | * :copyright: Copyright 2007-2016 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,6 +124,7 @@ var Documentation = { | |||
| 124 | this.fixFirefoxAnchorBug(); | 124 | this.fixFirefoxAnchorBug(); |
| 125 | this.highlightSearchWords(); | 125 | this.highlightSearchWords(); |
| 126 | this.initIndexTable(); | 126 | this.initIndexTable(); |
| 127 | |||
| 127 | }, | 128 | }, |
| 128 | 129 | ||
| 129 | /** | 130 | /** |
| @@ -252,6 +253,29 @@ var Documentation = { | |||
| 252 | }); | 253 | }); |
| 253 | var url = parts.join('/'); | 254 | var url = parts.join('/'); |
| 254 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); | 255 | 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 | }); | ||
| 255 | } | 279 | } |
| 256 | }; | 280 | }; |
| 257 | 281 | ||
| @@ -260,4 +284,4 @@ _ = Documentation.gettext; | |||
| 260 | 284 | ||
| 261 | $(document).ready(function() { | 285 | $(document).ready(function() { |
| 262 | Documentation.init(); | 286 | Documentation.init(); |
| 263 | }); | 287 | }); \ No newline at end of file |
diff --git a/_static/searchtools.js b/_static/searchtools.js index 0e794fd..a51e0dc 100644 --- a/_static/searchtools.js +++ b/_static/searchtools.js | |||
| @@ -2,14 +2,15 @@ | |||
| 2 | * searchtools.js_t | 2 | * searchtools.js_t |
| 3 | * ~~~~~~~~~~~~~~~~ | 3 | * ~~~~~~~~~~~~~~~~ |
| 4 | * | 4 | * |
| 5 | * Sphinx JavaScript utilties for the full-text search. | 5 | * Sphinx JavaScript utilities for the full-text search. |
| 6 | * | 6 | * |
| 7 | * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. | 7 | * :copyright: Copyright 2007-2016 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 */ | ||
| 13 | /** | 14 | /** |
| 14 | * Porter Stemmer | 15 | * Porter Stemmer |
| 15 | */ | 16 | */ |
| @@ -323,7 +324,7 @@ var Search = { | |||
| 323 | var searchterms = []; | 324 | var searchterms = []; |
| 324 | var excluded = []; | 325 | var excluded = []; |
| 325 | var hlterms = []; | 326 | var hlterms = []; |
| 326 | var tmp = query.split(/\s+/); | 327 | var tmp = query.split(/\W+/); |
| 327 | var objectterms = []; | 328 | var objectterms = []; |
| 328 | for (i = 0; i < tmp.length; i++) { | 329 | for (i = 0; i < tmp.length; i++) { |
| 329 | if (tmp[i] !== "") { | 330 | if (tmp[i] !== "") { |
| @@ -373,8 +374,7 @@ var Search = { | |||
| 373 | } | 374 | } |
| 374 | 375 | ||
| 375 | // lookup as search terms in fulltext | 376 | // lookup as search terms in fulltext |
| 376 | results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term)) | 377 | results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms)); |
| 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,23 +538,47 @@ 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, score) { | 541 | performTermsSearch : function(searchterms, excluded, terms, titleterms) { |
| 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, files; | 545 | var i, j, file; |
| 546 | var fileMap = {}; | 546 | var fileMap = {}; |
| 547 | var scoreMap = {}; | ||
| 547 | var results = []; | 548 | var results = []; |
| 548 | 549 | ||
| 549 | // perform the search on the required terms | 550 | // perform the search on the required terms |
| 550 | for (i = 0; i < searchterms.length; i++) { | 551 | for (i = 0; i < searchterms.length; i++) { |
| 551 | var word = searchterms[i]; | 552 | 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 | |||
| 552 | // no match but word was a required one | 559 | // no match but word was a required one |
| 553 | if ((files = terms[word]) === undefined) | 560 | if ($u.every(_o, function(o){return o.files === undefined;})) { |
| 554 | break; | 561 | break; |
| 555 | if (files.length === undefined) { | ||
| 556 | files = [files]; | ||
| 557 | } | 562 | } |
| 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 | |||
| 558 | // create the mapping | 582 | // create the mapping |
| 559 | for (j = 0; j < files.length; j++) { | 583 | for (j = 0; j < files.length; j++) { |
| 560 | file = files[j]; | 584 | file = files[j]; |
| @@ -576,7 +600,9 @@ var Search = { | |||
| 576 | // ensure that none of the excluded terms is in the search result | 600 | // ensure that none of the excluded terms is in the search result |
| 577 | for (i = 0; i < excluded.length; i++) { | 601 | for (i = 0; i < excluded.length; i++) { |
| 578 | if (terms[excluded[i]] == file || | 602 | if (terms[excluded[i]] == file || |
| 579 | $u.contains(terms[excluded[i]] || [], file)) { | 603 | titleterms[excluded[i]] == file || |
| 604 | $u.contains(terms[excluded[i]] || [], file) || | ||
| 605 | $u.contains(titleterms[excluded[i]] || [], file)) { | ||
| 580 | valid = false; | 606 | valid = false; |
| 581 | break; | 607 | break; |
| 582 | } | 608 | } |
| @@ -584,6 +610,9 @@ var Search = { | |||
| 584 | 610 | ||
| 585 | // if we have still a valid result we can add it to the result list | 611 | // if we have still a valid result we can add it to the result list |
| 586 | if (valid) { | 612 | 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]})); | ||
| 587 | results.push([filenames[file], titles[file], '', null, score]); | 616 | results.push([filenames[file], titles[file], '', null, score]); |
| 588 | } | 617 | } |
| 589 | } | 618 | } |
| @@ -594,7 +623,7 @@ var Search = { | |||
| 594 | * helper function to return a node containing the | 623 | * helper function to return a node containing the |
| 595 | * search summary for a given text. keywords is a list | 624 | * search summary for a given text. keywords is a list |
| 596 | * of stemmed words, hlwords is the list of normal, unstemmed | 625 | * of stemmed words, hlwords is the list of normal, unstemmed |
| 597 | * words. the first one is used to find the occurance, the | 626 | * words. the first one is used to find the occurrence, the |
| 598 | * latter for highlighting it. | 627 | * latter for highlighting it. |
| 599 | */ | 628 | */ |
| 600 | makeSearchSummary : function(text, keywords, hlwords) { | 629 | makeSearchSummary : function(text, keywords, hlwords) { |
diff --git a/_static/websupport.js b/_static/websupport.js index 28d65db..98e7f40 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 utilties for all documentation. | 5 | * sphinx.websupport utilities for all documentation. |
| 6 | * | 6 | * |
| 7 | * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. | 7 | * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. |
| 8 | * :license: BSD, see LICENSE for details. | 8 | * :license: BSD, see LICENSE for details. |
| 9 | * | 9 | * |
| 10 | */ | 10 | */ |
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="next" title="client – Client Utilities" href="client.html"/> | 37 | <link rel="next" title="client – Client Utilities" href="client.html"/> |
| 35 | <link rel="prev" title="Settings" href="settings_file.html"/> | 38 | <link rel="prev" title="Settings" href="settings_file.html"/> |
| @@ -60,7 +63,7 @@ | |||
| 60 | 63 | ||
| 61 | 64 | ||
| 62 | <div class="version"> | 65 | <div class="version"> |
| 63 | 0.2.6.2 | 66 | 0.2.6.3 |
| 64 | </div> | 67 | </div> |
| 65 | 68 | ||
| 66 | 69 | ||
| @@ -83,7 +86,7 @@ | |||
| 83 | 86 | ||
| 84 | <ul class="current"> | 87 | <ul class="current"> |
| 85 | <li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li> | 88 | <li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li> |
| 86 | <li class="toctree-l1 current"><a class="current reference internal" href="">API Documentation</a><ul> | 89 | <li class="toctree-l1 current"><a class="current reference internal" href="#">API Documentation</a><ul> |
| 87 | <li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> | 90 | <li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> |
| 88 | <li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> | 91 | <li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> |
| 89 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> | 92 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> |
| @@ -117,7 +120,7 @@ | |||
| 117 | <div class="rst-content"> | 120 | <div class="rst-content"> |
| 118 | 121 | ||
| 119 | 122 | ||
| 120 | 123 | ||
| 121 | 124 | ||
| 122 | 125 | ||
| 123 | 126 | ||
diff --git a/client.html b/client.html index dab0af9..4ce61c4 100644 --- a/client.html +++ b/client.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="api.html"/> | 37 | <link rel="up" title="API Documentation" href="api.html"/> |
| 35 | <link rel="next" title="messages – Client Messaging" href="client/messages.html"/> | 38 | <link rel="next" title="messages – Client Messaging" href="client/messages.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -85,7 +88,7 @@ | |||
| 85 | <ul class="current"> | 88 | <ul class="current"> |
| 86 | <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="using.html">Using EventMQ</a></li> |
| 87 | <li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> | 90 | <li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> |
| 88 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a><ul> | 91 | <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a><ul> |
| 89 | <li class="toctree-l3"><a class="reference internal" href="client/messages.html"><code class="docutils literal"><span class="pre">messages</span></code> – Client Messaging</a></li> | 92 | <li class="toctree-l3"><a class="reference internal" href="client/messages.html"><code class="docutils literal"><span class="pre">messages</span></code> – Client Messaging</a></li> |
| 90 | </ul> | 93 | </ul> |
| 91 | </li> | 94 | </li> |
| @@ -121,7 +124,7 @@ | |||
| 121 | <div class="rst-content"> | 124 | <div class="rst-content"> |
| 122 | 125 | ||
| 123 | 126 | ||
| 124 | 127 | ||
| 125 | 128 | ||
| 126 | 129 | ||
| 127 | 130 | ||
diff --git a/client/messages.html b/client/messages.html index b59cf18..786c501 100644 --- a/client/messages.html +++ b/client/messages.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="client – Client Utilities" href="../client.html"/> | 37 | <link rel="up" title="client – Client Utilities" href="../client.html"/> |
| 35 | <link rel="next" title="exceptions – Exceptions" href="../exceptions.html"/> | 38 | <link rel="next" title="exceptions – Exceptions" href="../exceptions.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -86,7 +89,7 @@ | |||
| 86 | <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="../using.html">Using EventMQ</a></li> |
| 87 | <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current"> | 90 | <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</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> – Client Utilities</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> – Client Utilities</a><ul class="current"> |
| 89 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">messages</span></code> – Client Messaging</a></li> | 92 | <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">messages</span></code> – Client Messaging</a></li> |
| 90 | </ul> | 93 | </ul> |
| 91 | </li> | 94 | </li> |
| 92 | <li class="toctree-l2"><a class="reference internal" href="../exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> | 95 | <li class="toctree-l2"><a class="reference internal" href="../exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> |
| @@ -121,7 +124,7 @@ | |||
| 121 | <div class="rst-content"> | 124 | <div class="rst-content"> |
| 122 | 125 | ||
| 123 | 126 | ||
| 124 | 127 | ||
| 125 | 128 | ||
| 126 | 129 | ||
| 127 | 130 | ||
| @@ -151,7 +154,7 @@ | |||
| 151 | <h1><code class="xref py py-mod docutils literal"><span class="pre">messages</span></code> – Client Messaging<a class="headerlink" href="#messages-client-messaging" title="Permalink to this headline">¶</a></h1> | 154 | <h1><code class="xref py py-mod docutils literal"><span class="pre">messages</span></code> – Client Messaging<a class="headerlink" href="#messages-client-messaging" title="Permalink to this headline">¶</a></h1> |
| 152 | <dl class="function"> | 155 | <dl class="function"> |
| 153 | <dt id="eventmq.client.messages.defer_job"> | 156 | <dt id="eventmq.client.messages.defer_job"> |
| 154 | <code class="descclassname">eventmq.client.messages.</code><code class="descname">defer_job</code><span class="sig-paren">(</span><em>socket</em>, <em>func</em>, <em>args=()</em>, <em>kwargs=None</em>, <em>class_args=()</em>, <em>class_kwargs=None</em>, <em>reply_requested=False</em>, <em>guarantee=False</em>, <em>retry_count=0</em>, <em>debounce_secs=False</em>, <em>queue='default'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.defer_job" title="Permalink to this definition">¶</a></dt> | 157 | <code class="descclassname">eventmq.client.messages.</code><code class="descname">defer_job</code><span class="sig-paren">(</span><em>socket</em>, <em>func</em>, <em>wrapper=None</em>, <em>args=()</em>, <em>kwargs=None</em>, <em>class_args=()</em>, <em>class_kwargs=None</em>, <em>reply_requested=False</em>, <em>guarantee=False</em>, <em>retry_count=0</em>, <em>debounce_secs=False</em>, <em>queue='default'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.defer_job" title="Permalink to this definition">¶</a></dt> |
| 155 | <dd><p>Used to send a job to a worker to execute via <cite>socket</cite>.</p> | 158 | <dd><p>Used to send a job to a worker to execute via <cite>socket</cite>.</p> |
| 156 | <p>This tries not to raise any exceptions so use some of the message flags to | 159 | <p>This tries not to raise any exceptions so use some of the message flags to |
| 157 | guarentee things.</p> | 160 | guarentee things.</p> |
| @@ -160,31 +163,37 @@ guarentee things.</p> | |||
| 160 | <col class="field-body" /> | 163 | <col class="field-body" /> |
| 161 | <tbody valign="top"> | 164 | <tbody valign="top"> |
| 162 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 165 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 163 | <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>) – eventmq socket to use for sending the message</li> | 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>) – eventmq socket to use for sending the message</li> |
| 164 | <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>) – the callable to be deferred to a worker</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>) – the callable to be deferred to a worker</li> |
| 165 | <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>) – list of <a href="#id1"><span class="problematic" id="id2">*</span></a>args for the callable</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>) – optional wrapper for the call to func to be |
| 166 | <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>) – dict of <a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs for the callable</li> | 169 | wrapped with</li> |
| 167 | <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>) – list of <a href="#id5"><span class="problematic" id="id6">*</span></a>args to pass to the the class when | 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>) – 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>) – 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>) – list of <a href="#id5"><span class="problematic" id="id6">*</span></a>args to pass to the the class when | ||
| 168 | initializing (if applicable).</li> | 173 | initializing (if applicable).</li> |
| 169 | <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>) – dict of <a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs to pass to the class when | 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>) – dict of <a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs to pass to the class when |
| 170 | initializing (if applicable).</li> | 175 | initializing (if applicable).</li> |
| 171 | <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>) – request the return value of func as a reply</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>) – request the return value of func as a reply</li> |
| 172 | <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>) – How many times should be retried when encountering | 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>) – How many times should be retried when encountering |
| 173 | an Exception or some other failure before giving up. (default: 0 | 178 | an Exception or some other failure before giving up. (default: 0 |
| 174 | or immediately fail)</li> | 179 | or immediately fail)</li> |
| 175 | <li><strong>debounce_secs</strong> (<em>secs</em>) – Number of seconds to debounce the job. See | 180 | <li><strong>debounce_secs</strong> (<em>secs</em>) – Number of seconds to debounce the job. See |
| 176 | <cite>debounce_deferred_job</cite> for more information.</li> | 181 | <cite>debounce_deferred_job</cite> for more information.</li> |
| 177 | <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>) – Name of queue to use when executing the job. If this value | 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>) – Name of queue to use when executing the job. If this value |
| 178 | evaluates to False, the default is used. Default: is configured | 183 | evaluates to False, the default is used. Default: is configured |
| 179 | default queue name</li> | 184 | default queue name</li> |
| 180 | </ul> | 185 | </ul> |
| 181 | </td> | 186 | </td> |
| 182 | </tr> | 187 | </tr> |
| 183 | <tr class="field-even 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 | 188 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils"> |
| 184 | was an error.</p> | 189 | <dt>ID for the message/deferred job. This value will be None if there</dt> |
| 190 | <dd><p class="first last">was an error.</p> | ||
| 191 | </dd> | ||
| 192 | </dl> | ||
| 193 | </p> | ||
| 185 | </td> | 194 | </td> |
| 186 | </tr> | 195 | </tr> |
| 187 | <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> | 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> |
| 188 | </td> | 197 | </td> |
| 189 | </tr> | 198 | </tr> |
| 190 | </tbody> | 199 | </tbody> |
| @@ -200,29 +209,33 @@ was an error.</p> | |||
| 200 | <col class="field-body" /> | 209 | <col class="field-body" /> |
| 201 | <tbody valign="top"> | 210 | <tbody valign="top"> |
| 202 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 211 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 203 | <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>) – eventmq socket to use for sending the message</li> | 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>) – eventmq socket to use for sending the message</li> |
| 204 | <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>) – the callable to be scheduled on a worker</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>) – the callable to be scheduled on a worker</li> |
| 205 | <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>) – minutes to wait in between executions</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>) – minutes to wait in between executions</li> |
| 206 | <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>) – list of <a href="#id9"><span class="problematic" id="id10">*</span></a>args to pass to the callable</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>) – list of <a href="#id9"><span class="problematic" id="id10">*</span></a>args to pass to the callable</li> |
| 207 | <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>) – Run job every interval_secs or None if using cron</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>) – Run job every interval_secs or None if using cron</li> |
| 208 | <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>) – cron formatted string used for job schedule if | 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>) – cron formatted string used for job schedule if |
| 209 | interval_secs is None, i.e. ‘* * * * <a href="#id11"><span class="problematic" id="id12">*</span></a>‘ (every minute)</li> | 218 | interval_secs is None, i.e. ‘* * * * <a href="#id11"><span class="problematic" id="id12">*</span></a>‘ (every minute)</li> |
| 210 | <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>) – dict of <a href="#id13"><span class="problematic" id="id14">**</span></a>kwargs to pass to the callable</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>) – dict of <a href="#id13"><span class="problematic" id="id14">**</span></a>kwargs to pass to the callable</li> |
| 211 | <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>) – list of <a href="#id15"><span class="problematic" id="id16">*</span></a>args to pass to the class (if applicable)</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>) – list of <a href="#id15"><span class="problematic" id="id16">*</span></a>args to pass to the class (if applicable)</li> |
| 212 | <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>) – dict of <a href="#id17"><span class="problematic" id="id18">**</span></a>kwargs to pass to the class (if | 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>) – dict of <a href="#id17"><span class="problematic" id="id18">**</span></a>kwargs to pass to the class (if |
| 213 | applicable)</li> | 222 | applicable)</li> |
| 214 | <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>) – list of strings denoting enabled headers. Default: | 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>) – list of strings denoting enabled headers. Default: |
| 215 | guarantee is enabled to ensure the scheduler schedules the job.</li> | 224 | guarantee is enabled to ensure the scheduler schedules the job.</li> |
| 216 | <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>) – name of the queue to use when executing the job. The | 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>) – name of the queue to use when executing the job. The |
| 217 | default value is the default queue.</li> | 226 | default value is the default queue.</li> |
| 218 | </ul> | 227 | </ul> |
| 219 | </td> | 228 | </td> |
| 220 | </tr> | 229 | </tr> |
| 221 | <tr class="field-even 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 | 230 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils"> |
| 222 | error</p> | 231 | <dt>ID of the schedule message that was sent. None if there was an</dt> |
| 232 | <dd><p class="first last">error</p> | ||
| 233 | </dd> | ||
| 234 | </dl> | ||
| 235 | </p> | ||
| 223 | </td> | 236 | </td> |
| 224 | </tr> | 237 | </tr> |
| 225 | <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> | 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> |
| 226 | </td> | 239 | </td> |
| 227 | </tr> | 240 | </tr> |
| 228 | </tbody> | 241 | </tbody> |
| @@ -268,10 +281,10 @@ the headers then they have been enabled.</p> | |||
| 268 | <col class="field-body" /> | 281 | <col class="field-body" /> |
| 269 | <tbody valign="top"> | 282 | <tbody valign="top"> |
| 270 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 283 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 271 | <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>) – How many times should be retried when encountering | 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>) – How many times should be retried when encountering |
| 272 | an Exception or some other failure before giving up. (default: 0 | 285 | an Exception or some other failure before giving up. (default: 0 |
| 273 | or immediatly fail)</li> | 286 | or immediatly fail)</li> |
| 274 | <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>) – Name of queue to use when executing the job. Default: is | 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>) – Name of queue to use when executing the job. Default: is |
| 275 | configured default queue name</li> | 288 | configured default queue name</li> |
| 276 | </ul> | 289 | </ul> |
| 277 | </td> | 290 | </td> |
| @@ -279,7 +292,7 @@ configured default queue name</li> | |||
| 279 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> | 292 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> |
| 280 | </td> | 293 | </td> |
| 281 | </tr> | 294 | </tr> |
| 282 | <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> | 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> |
| 283 | </td> | 296 | </td> |
| 284 | </tr> | 297 | </tr> |
| 285 | </tbody> | 298 | </tbody> |
| @@ -297,18 +310,18 @@ interval for the scheduler.</p> | |||
| 297 | <col class="field-body" /> | 310 | <col class="field-body" /> |
| 298 | <tbody valign="top"> | 311 | <tbody valign="top"> |
| 299 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 312 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 300 | <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>) – </li> | 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>) – </li> |
| 301 | <li><strong>job_schedule</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – </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>) – </li> |
| 302 | <li><strong>message</strong> – Message to send socket.</li> | 315 | <li><strong>message</strong> – Message to send socket.</li> |
| 303 | <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>) – List of headers for the message</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>) – List of headers for the message</li> |
| 304 | <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>) – name of queue the job should be executed in</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>) – name of queue the job should be executed in</li> |
| 305 | </ul> | 318 | </ul> |
| 306 | </td> | 319 | </td> |
| 307 | </tr> | 320 | </tr> |
| 308 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> | 321 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> |
| 309 | </td> | 322 | </td> |
| 310 | </tr> | 323 | </tr> |
| 311 | <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> | 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> |
| 312 | </td> | 325 | </td> |
| 313 | </tr> | 326 | </tr> |
| 314 | </tbody> | 327 | </tbody> |
diff --git a/contributing.html b/contributing.html index 45ee99e..7654b29 100644 --- a/contributing.html +++ b/contributing.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="next" title="EventMQ Protocol Specification" href="protocol.html"/> | 37 | <link rel="next" title="EventMQ Protocol Specification" href="protocol.html"/> |
| 35 | <link rel="prev" title="timeutils – Time Utilites" href="utils/timeutils.html"/> | 38 | <link rel="prev" title="timeutils – Time Utilites" href="utils/timeutils.html"/> |
| @@ -60,7 +63,7 @@ | |||
| 60 | 63 | ||
| 61 | 64 | ||
| 62 | <div class="version"> | 65 | <div class="version"> |
| 63 | 0.2.6.2 | 66 | 0.2.6.3 |
| 64 | </div> | 67 | </div> |
| 65 | 68 | ||
| 66 | 69 | ||
| @@ -84,7 +87,7 @@ | |||
| 84 | <ul class="current"> | 87 | <ul class="current"> |
| 85 | <li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li> | 88 | <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="api.html">API Documentation</a></li> | 89 | <li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li> |
| 87 | <li class="toctree-l1 current"><a class="current reference internal" href="">Contributing to EventMQ</a><ul> | 90 | <li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to EventMQ</a><ul> |
| 88 | <li class="toctree-l2"><a class="reference internal" href="protocol.html">EventMQ Protocol Specification</a></li> | 91 | <li class="toctree-l2"><a class="reference internal" href="protocol.html">EventMQ Protocol Specification</a></li> |
| 89 | <li class="toctree-l2"><a class="reference external" href="https://github.com/enderlabs/eventmq">Source Code</a></li> | 92 | <li class="toctree-l2"><a class="reference external" href="https://github.com/enderlabs/eventmq">Source Code</a></li> |
| 90 | <li class="toctree-l2"><a class="reference external" href="https://github.com/enderlabs/eventmq/issues">Issues</a></li> | 93 | <li class="toctree-l2"><a class="reference external" href="https://github.com/enderlabs/eventmq/issues">Issues</a></li> |
| @@ -112,7 +115,7 @@ | |||
| 112 | <div class="rst-content"> | 115 | <div class="rst-content"> |
| 113 | 116 | ||
| 114 | 117 | ||
| 115 | 118 | ||
| 116 | 119 | ||
| 117 | 120 | ||
| 118 | 121 | ||
diff --git a/exceptions.html b/exceptions.html index b3a9914..4b6baae 100644 --- a/exceptions.html +++ b/exceptions.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="api.html"/> | 37 | <link rel="up" title="API Documentation" href="api.html"/> |
| 35 | <link rel="next" title="jobmanager – Job Manager" href="jobmanager.html"/> | 38 | <link rel="next" title="jobmanager – Job Manager" href="jobmanager.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -86,7 +89,7 @@ | |||
| 86 | <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="using.html">Using EventMQ</a></li> |
| 87 | <li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> | 90 | <li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> |
| 88 | <li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> | 91 | <li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> |
| 89 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> | 92 | <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> |
| 90 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> | 93 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> |
| 91 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> | 94 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> |
| 92 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 95 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| @@ -118,7 +121,7 @@ | |||
| 118 | <div class="rst-content"> | 121 | <div class="rst-content"> |
| 119 | 122 | ||
| 120 | 123 | ||
| 121 | 124 | ||
| 122 | 125 | ||
| 123 | 126 | ||
| 124 | 127 | ||
| @@ -143,7 +146,7 @@ | |||
| 143 | <div itemprop="articleBody"> | 146 | <div itemprop="articleBody"> |
| 144 | 147 | ||
| 145 | <span class="target" id="module-eventmq.exceptions"></span><div class="section" id="exceptions-exceptions"> | 148 | <span class="target" id="module-eventmq.exceptions"></span><div class="section" id="exceptions-exceptions"> |
| 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> – Exceptions<a class="headerlink" href="#exceptions-exceptions" title="Permalink to this headline">¶</a></h1> | 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> – Exceptions<a class="headerlink" href="#exceptions-exceptions" title="Permalink to this headline">¶</a></h1> |
| 147 | <p>These are the exceptions that are raised by EventMQ. All exceptions should | 150 | <p>These are the exceptions that are raised by EventMQ. All exceptions should |
| 148 | be 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> | 151 | be 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> |
| 149 | <dl class="exception"> | 152 | <dl class="exception"> |
diff --git a/genindex.html b/genindex.html index 6bd3f7f..070a070 100644 --- a/genindex.html +++ b/genindex.html | |||
| @@ -31,6 +31,9 @@ | |||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | 33 | ||
| 34 | <link rel="index" title="Index" | ||
| 35 | href="#"/> | ||
| 36 | <link rel="search" title="Search" href="search.html"/> | ||
| 34 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 37 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 35 | 38 | ||
| 36 | 39 | ||
| @@ -59,7 +62,7 @@ | |||
| 59 | 62 | ||
| 60 | 63 | ||
| 61 | <div class="version"> | 64 | <div class="version"> |
| 62 | 0.2.6.2 | 65 | 0.2.6.3 |
| 63 | </div> | 66 | </div> |
| 64 | 67 | ||
| 65 | 68 | ||
| @@ -457,12 +460,12 @@ | |||
| 457 | <dt><a href="router.html#eventmq.router.Router.job_latencies">job_latencies (eventmq.router.Router attribute)</a> | 460 | <dt><a href="router.html#eventmq.router.Router.job_latencies">job_latencies (eventmq.router.Router attribute)</a> |
| 458 | </dt> | 461 | </dt> |
| 459 | 462 | ||
| 463 | </dl></td> | ||
| 464 | <td style="width: 33%" valign="top"><dl> | ||
| 460 | 465 | ||
| 461 | <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager">JobManager (class in eventmq.jobmanager)</a> | 466 | <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager">JobManager (class in eventmq.jobmanager)</a> |
| 462 | </dt> | 467 | </dt> |
| 463 | 468 | ||
| 464 | </dl></td> | ||
| 465 | <td style="width: 33%" valign="top"><dl> | ||
| 466 | 469 | ||
| 467 | <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager.jobmanager_main">jobmanager_main() (eventmq.jobmanager.JobManager method)</a> | 470 | <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager.jobmanager_main">jobmanager_main() (eventmq.jobmanager.JobManager method)</a> |
| 468 | </dt> | 471 | </dt> |
| @@ -493,12 +496,12 @@ | |||
| 493 | <dt><a href="exceptions.html#eventmq.exceptions.MessageError">MessageError</a> | 496 | <dt><a href="exceptions.html#eventmq.exceptions.MessageError">MessageError</a> |
| 494 | </dt> | 497 | </dt> |
| 495 | 498 | ||
| 499 | </dl></td> | ||
| 500 | <td style="width: 33%" valign="top"><dl> | ||
| 496 | 501 | ||
| 497 | <dt><a href="utils/timeutils.html#eventmq.utils.timeutils.monotonic">monotonic() (in module eventmq.utils.timeutils)</a> | 502 | <dt><a href="utils/timeutils.html#eventmq.utils.timeutils.monotonic">monotonic() (in module eventmq.utils.timeutils)</a> |
| 498 | </dt> | 503 | </dt> |
| 499 | 504 | ||
| 500 | </dl></td> | ||
| 501 | <td style="width: 33%" valign="top"><dl> | ||
| 502 | 505 | ||
| 503 | <dt><a href="jobmanager.html#eventmq.jobmanager.mp_init">mp_init() (in module eventmq.jobmanager)</a> | 506 | <dt><a href="jobmanager.html#eventmq.jobmanager.mp_init">mp_init() (in module eventmq.jobmanager)</a> |
| 504 | </dt> | 507 | </dt> |
| @@ -607,12 +610,12 @@ | |||
| 607 | <dt><a href="poller.html#eventmq.poller.Poller">Poller (class in eventmq.poller)</a> | 610 | <dt><a href="poller.html#eventmq.poller.Poller">Poller (class in eventmq.poller)</a> |
| 608 | </dt> | 611 | </dt> |
| 609 | 612 | ||
| 613 | </dl></td> | ||
| 614 | <td style="width: 33%" valign="top"><dl> | ||
| 610 | 615 | ||
| 611 | <dt><a href="utils/classes.html#eventmq.utils.classes.EMQdeque.pop">pop() (eventmq.utils.classes.EMQdeque method)</a> | 616 | <dt><a href="utils/classes.html#eventmq.utils.classes.EMQdeque.pop">pop() (eventmq.utils.classes.EMQdeque method)</a> |
| 612 | </dt> | 617 | </dt> |
| 613 | 618 | ||
| 614 | </dl></td> | ||
| 615 | <td style="width: 33%" valign="top"><dl> | ||
| 616 | 619 | ||
| 617 | <dt><a href="utils/classes.html#eventmq.utils.classes.EMQdeque.popleft">popleft() (eventmq.utils.classes.EMQdeque method)</a> | 620 | <dt><a href="utils/classes.html#eventmq.utils.classes.EMQdeque.popleft">popleft() (eventmq.utils.classes.EMQdeque method)</a> |
| 618 | </dt> | 621 | </dt> |
| @@ -857,12 +860,12 @@ | |||
| 857 | </dt> | 860 | </dt> |
| 858 | 861 | ||
| 859 | </dl></dd> | 862 | </dl></dd> |
| 863 | </dl></td> | ||
| 864 | <td style="width: 33%" valign="top"><dl> | ||
| 860 | 865 | ||
| 861 | <dt><a href="exceptions.html#eventmq.exceptions.UnknownQueueError">UnknownQueueError</a> | 866 | <dt><a href="exceptions.html#eventmq.exceptions.UnknownQueueError">UnknownQueueError</a> |
| 862 | </dt> | 867 | </dt> |
| 863 | 868 | ||
| 864 | </dl></td> | ||
| 865 | <td style="width: 33%" valign="top"><dl> | ||
| 866 | 869 | ||
| 867 | <dt><a href="poller.html#eventmq.poller.Poller.unregister">unregister() (eventmq.poller.Poller method)</a> | 870 | <dt><a href="poller.html#eventmq.poller.Poller.unregister">unregister() (eventmq.poller.Poller method)</a> |
| 868 | </dt> | 871 | </dt> |
| @@ -903,12 +906,12 @@ | |||
| 903 | <dt><a href="utils/index.html#eventmq.utils.zero_index_cmp">zero_index_cmp() (in module eventmq.utils)</a> | 906 | <dt><a href="utils/index.html#eventmq.utils.zero_index_cmp">zero_index_cmp() (in module eventmq.utils)</a> |
| 904 | </dt> | 907 | </dt> |
| 905 | 908 | ||
| 909 | </dl></td> | ||
| 910 | <td style="width: 33%" valign="top"><dl> | ||
| 906 | 911 | ||
| 907 | <dt><a href="utils/classes.html#eventmq.utils.classes.ZMQReceiveMixin">ZMQReceiveMixin (class in eventmq.utils.classes)</a> | 912 | <dt><a href="utils/classes.html#eventmq.utils.classes.ZMQReceiveMixin">ZMQReceiveMixin (class in eventmq.utils.classes)</a> |
| 908 | </dt> | 913 | </dt> |
| 909 | 914 | ||
| 910 | </dl></td> | ||
| 911 | <td style="width: 33%" valign="top"><dl> | ||
| 912 | 915 | ||
| 913 | <dt><a href="utils/classes.html#eventmq.utils.classes.ZMQSendMixin">ZMQSendMixin (class in eventmq.utils.classes)</a> | 916 | <dt><a href="utils/classes.html#eventmq.utils.classes.ZMQSendMixin">ZMQSendMixin (class in eventmq.utils.classes)</a> |
| 914 | </dt> | 917 | </dt> |
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="#"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="#"/> |
| 34 | <link rel="next" title="Using EventMQ" href="using.html"/> | 37 | <link rel="next" title="Using EventMQ" href="using.html"/> |
| 35 | 38 | ||
| @@ -59,7 +62,7 @@ | |||
| 59 | 62 | ||
| 60 | 63 | ||
| 61 | <div class="version"> | 64 | <div class="version"> |
| 62 | 0.2.6.2 | 65 | 0.2.6.3 |
| 63 | </div> | 66 | </div> |
| 64 | 67 | ||
| 65 | 68 | ||
| @@ -106,7 +109,7 @@ | |||
| 106 | <div class="rst-content"> | 109 | <div class="rst-content"> |
| 107 | 110 | ||
| 108 | 111 | ||
| 109 | 112 | ||
| 110 | 113 | ||
| 111 | 114 | ||
| 112 | 115 | ||
| @@ -158,9 +161,9 @@ | |||
| 158 | <div class="section" id="indices-and-tables"> | 161 | <div class="section" id="indices-and-tables"> |
| 159 | <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2> | 162 | <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2> |
| 160 | <ul class="simple"> | 163 | <ul class="simple"> |
| 161 | <li><a class="reference internal" href="genindex.html"><span>Index</span></a></li> | 164 | <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li> |
| 162 | <li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li> | 165 | <li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li> |
| 163 | <li><a class="reference internal" href="search.html"><span>Search Page</span></a></li> | 166 | <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li> |
| 164 | </ul> | 167 | </ul> |
| 165 | </div> | 168 | </div> |
| 166 | </div> | 169 | </div> |
diff --git a/jobmanager.html b/jobmanager.html index 7712021..d962271 100644 --- a/jobmanager.html +++ b/jobmanager.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="api.html"/> | 37 | <link rel="up" title="API Documentation" href="api.html"/> |
| 35 | <link rel="next" title="poller – Poller" href="poller.html"/> | 38 | <link rel="next" title="poller – Poller" href="poller.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -87,7 +90,7 @@ | |||
| 87 | <li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> | 90 | <li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> |
| 88 | <li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> | 91 | <li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> |
| 89 | <li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – 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> – Exceptions</a></li> |
| 90 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> | 93 | <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> |
| 91 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> | 94 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> |
| 92 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 95 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| 93 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 96 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| @@ -118,7 +121,7 @@ | |||
| 118 | <div class="rst-content"> | 121 | <div class="rst-content"> |
| 119 | 122 | ||
| 120 | 123 | ||
| 121 | 124 | ||
| 122 | 125 | ||
| 123 | 126 | ||
| 124 | 127 | ||
| @@ -163,10 +166,10 @@ to manage the resources on the server it’s running.</p> | |||
| 163 | <col class="field-body" /> | 166 | <col class="field-body" /> |
| 164 | <tbody valign="top"> | 167 | <tbody valign="top"> |
| 165 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 168 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 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>) – unique name of this instance. By default a uuid will be | 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>) – unique name of this instance. By default a uuid will be |
| 167 | generated.</li> | 170 | generated.</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>) – List of queue names to listen on.</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>) – List of queue names to listen on.</li> |
| 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>) – Don’t register the signal handlers. Useful for | 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>) – Don’t register the signal handlers. Useful for |
| 170 | testing.</li> | 173 | testing.</li> |
| 171 | </ul> | 174 | </ul> |
| 172 | </td> | 175 | </td> |
| @@ -189,7 +192,7 @@ testing.</li> | |||
| 189 | <col class="field-name" /> | 192 | <col class="field-name" /> |
| 190 | <col class="field-body" /> | 193 | <col class="field-body" /> |
| 191 | <tbody valign="top"> | 194 | <tbody valign="top"> |
| 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>) – The address of the broker to connect to.</td> | 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>) – The address of the broker to connect to.</td> |
| 193 | </tr> | 196 | </tr> |
| 194 | </tbody> | 197 | </tbody> |
| 195 | </table> | 198 | </table> |
| @@ -272,8 +275,8 @@ for another REQUEST message.</p> | |||
| 272 | <col class="field-body" /> | 275 | <col class="field-body" /> |
| 273 | <tbody valign="top"> | 276 | <tbody valign="top"> |
| 274 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 277 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 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>) – The socket to use for this ack</li> | 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>) – The socket to use for this 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>) – The recipient id for the 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>) – The recipient id for the ack</li> |
| 277 | <li><strong>msgid</strong> – The unique id that we are acknowledging</li> | 280 | <li><strong>msgid</strong> – The unique id that we are acknowledging</li> |
| 278 | </ul> | 281 | </ul> |
| 279 | </td> | 282 | </td> |
diff --git a/objects.inv b/objects.inv index 79ff0a4..9b383df 100644 --- a/objects.inv +++ b/objects.inv | |||
| Binary files differ | |||
diff --git a/poller.html b/poller.html index 4d406ae..2e476ea 100644 --- a/poller.html +++ b/poller.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="api.html"/> | 37 | <link rel="up" title="API Documentation" href="api.html"/> |
| 35 | <link rel="next" title="receiver – Receiver" href="receiver.html"/> | 38 | <link rel="next" title="receiver – Receiver" href="receiver.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -88,7 +91,7 @@ | |||
| 88 | <li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> | 91 | <li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> |
| 89 | <li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – 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> – Exceptions</a></li> |
| 90 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> | 93 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> |
| 91 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> | 94 | <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> |
| 92 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 95 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| 93 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 96 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 94 | <li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 97 | <li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> |
| @@ -118,7 +121,7 @@ | |||
| 118 | <div class="rst-content"> | 121 | <div class="rst-content"> |
| 119 | 122 | ||
| 120 | 123 | ||
| 121 | 124 | ||
| 122 | 125 | ||
| 123 | 126 | ||
| 124 | 127 | ||
| @@ -148,17 +151,17 @@ | |||
| 148 | <dl class="class"> | 151 | <dl class="class"> |
| 149 | <dt id="eventmq.poller.Poller"> | 152 | <dt id="eventmq.poller.Poller"> |
| 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> | 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> |
| 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> | 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> |
| 152 | <dl class="method"> | 155 | <dl class="method"> |
| 153 | <dt id="eventmq.poller.Poller.__init__"> | 156 | <dt id="eventmq.poller.Poller.__init__"> |
| 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> | 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> |
| 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> | 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> |
| 156 | </dd></dl> | 159 | </dd></dl> |
| 157 | 160 | ||
| 158 | <dl class="method"> | 161 | <dl class="method"> |
| 159 | <dt id="eventmq.poller.Poller.poll"> | 162 | <dt id="eventmq.poller.Poller.poll"> |
| 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> | 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> |
| 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 | 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 |
| 162 | method typecasts to a dictionary for convience using the socket object | 165 | method typecasts to a dictionary for convience using the socket object |
| 163 | as the key. If a socket doesn’t appear in the returned dictionary then | 166 | as the key. If a socket doesn’t appear in the returned dictionary then |
| 164 | no events happened.</p> | 167 | no events happened.</p> |
| @@ -166,7 +169,7 @@ no events happened.</p> | |||
| 166 | <col class="field-name" /> | 169 | <col class="field-name" /> |
| 167 | <col class="field-body" /> | 170 | <col class="field-body" /> |
| 168 | <tbody valign="top"> | 171 | <tbody valign="top"> |
| 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>) – How long should poller wait for before iterating | 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>) – How long should poller wait for before iterating |
| 170 | the next loop.</td> | 173 | the next loop.</td> |
| 171 | </tr> | 174 | </tr> |
| 172 | </tbody> | 175 | </tbody> |
| @@ -186,8 +189,8 @@ the next loop.</td> | |||
| 186 | <col class="field-body" /> | 189 | <col class="field-body" /> |
| 187 | <tbody valign="top"> | 190 | <tbody valign="top"> |
| 188 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 191 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 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>) – The socket object to register</li> | 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>) – The socket object to register</li> |
| 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>) – <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 | 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>) – <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 |
| 191 | <code class="xref py py-attr docutils literal"><span class="pre">POLLIN`|:attr:`POLLOUT</span></code> for both. If undefined the | 194 | <code class="xref py py-attr docutils literal"><span class="pre">POLLIN`|:attr:`POLLOUT</span></code> for both. If undefined the |
| 192 | socket remains unregistered.</li> | 195 | socket remains unregistered.</li> |
| 193 | </ul> | 196 | </ul> |
| @@ -205,7 +208,7 @@ socket remains unregistered.</li> | |||
| 205 | <col class="field-name" /> | 208 | <col class="field-name" /> |
| 206 | <col class="field-body" /> | 209 | <col class="field-body" /> |
| 207 | <tbody valign="top"> | 210 | <tbody valign="top"> |
| 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>) – The socket object to registering</td> | 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>) – The socket object to registering</td> |
| 209 | </tr> | 212 | </tr> |
| 210 | </tbody> | 213 | </tbody> |
| 211 | </table> | 214 | </table> |
diff --git a/protocol.html b/protocol.html index 828731e..876d1c1 100644 --- a/protocol.html +++ b/protocol.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="Contributing to EventMQ" href="contributing.html"/> | 37 | <link rel="up" title="Contributing to EventMQ" href="contributing.html"/> |
| 35 | <link rel="prev" title="Contributing to EventMQ" href="contributing.html"/> | 38 | <link rel="prev" title="Contributing to EventMQ" href="contributing.html"/> |
| @@ -60,7 +63,7 @@ | |||
| 60 | 63 | ||
| 61 | 64 | ||
| 62 | <div class="version"> | 65 | <div class="version"> |
| 63 | 0.2.6.2 | 66 | 0.2.6.3 |
| 64 | </div> | 67 | </div> |
| 65 | 68 | ||
| 66 | 69 | ||
| @@ -85,7 +88,7 @@ | |||
| 85 | <li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li> | 88 | <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="api.html">API Documentation</a></li> | 89 | <li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li> |
| 87 | <li class="toctree-l1 current"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a><ul class="current"> | 90 | <li class="toctree-l1 current"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a><ul class="current"> |
| 88 | <li class="toctree-l2 current"><a class="current reference internal" href="">EventMQ Protocol Specification</a><ul> | 91 | <li class="toctree-l2 current"><a class="current reference internal" href="#">EventMQ Protocol Specification</a><ul> |
| 89 | <li class="toctree-l3"><a class="reference internal" href="#goals">Goals</a></li> | 92 | <li class="toctree-l3"><a class="reference internal" href="#goals">Goals</a></li> |
| 90 | <li class="toctree-l3"><a class="reference internal" href="#license">License</a></li> | 93 | <li class="toctree-l3"><a class="reference internal" href="#license">License</a></li> |
| 91 | <li class="toctree-l3"><a class="reference internal" href="#language">Language</a></li> | 94 | <li class="toctree-l3"><a class="reference internal" href="#language">Language</a></li> |
| @@ -129,7 +132,7 @@ | |||
| 129 | <div class="rst-content"> | 132 | <div class="rst-content"> |
| 130 | 133 | ||
| 131 | 134 | ||
| 132 | 135 | ||
| 133 | 136 | ||
| 134 | 137 | ||
| 135 | 138 | ||
diff --git a/py-modindex.html b/py-modindex.html index 181c5b3..c9b583e 100644 --- a/py-modindex.html +++ b/py-modindex.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | 37 | ||
| 35 | 38 | ||
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -136,7 +139,7 @@ | |||
| 136 | </div> | 139 | </div> |
| 137 | 140 | ||
| 138 | <table class="indextable modindextable" cellspacing="0" cellpadding="2"> | 141 | <table class="indextable modindextable" cellspacing="0" cellpadding="2"> |
| 139 | <tr class="pcap"><td></td><td> </td><td></td></tr> | 142 | <tr class="pcap"><td></td><td> </td><td></td></tr> |
| 140 | <tr class="cap" id="cap-e"><td></td><td> | 143 | <tr class="cap" id="cap-e"><td></td><td> |
| 141 | <strong>e</strong></td><td></td></tr> | 144 | <strong>e</strong></td><td></td></tr> |
| 142 | <tr> | 145 | <tr> |
| @@ -147,72 +150,72 @@ | |||
| 147 | <em></em></td></tr> | 150 | <em></em></td></tr> |
| 148 | <tr class="cg-1"> | 151 | <tr class="cg-1"> |
| 149 | <td></td> | 152 | <td></td> |
| 150 | <td> | 153 | <td>    |
| 151 | <a href="client.html#module-eventmq.client"><code class="xref">eventmq.client</code></a></td><td> | 154 | <a href="client.html#module-eventmq.client"><code class="xref">eventmq.client</code></a></td><td> |
| 152 | <em></em></td></tr> | 155 | <em></em></td></tr> |
| 153 | <tr class="cg-1"> | 156 | <tr class="cg-1"> |
| 154 | <td></td> | 157 | <td></td> |
| 155 | <td> | 158 | <td>    |
| 156 | <a href="client/messages.html#module-eventmq.client.messages"><code class="xref">eventmq.client.messages</code></a></td><td> | 159 | <a href="client/messages.html#module-eventmq.client.messages"><code class="xref">eventmq.client.messages</code></a></td><td> |
| 157 | <em></em></td></tr> | 160 | <em></em></td></tr> |
| 158 | <tr class="cg-1"> | 161 | <tr class="cg-1"> |
| 159 | <td></td> | 162 | <td></td> |
| 160 | <td> | 163 | <td>    |
| 161 | <a href="exceptions.html#module-eventmq.exceptions"><code class="xref">eventmq.exceptions</code></a></td><td> | 164 | <a href="exceptions.html#module-eventmq.exceptions"><code class="xref">eventmq.exceptions</code></a></td><td> |
| 162 | <em></em></td></tr> | 165 | <em></em></td></tr> |
| 163 | <tr class="cg-1"> | 166 | <tr class="cg-1"> |
| 164 | <td></td> | 167 | <td></td> |
| 165 | <td> | 168 | <td>    |
| 166 | <a href="jobmanager.html#module-eventmq.jobmanager"><code class="xref">eventmq.jobmanager</code></a></td><td> | 169 | <a href="jobmanager.html#module-eventmq.jobmanager"><code class="xref">eventmq.jobmanager</code></a></td><td> |
| 167 | <em></em></td></tr> | 170 | <em></em></td></tr> |
| 168 | <tr class="cg-1"> | 171 | <tr class="cg-1"> |
| 169 | <td></td> | 172 | <td></td> |
| 170 | <td> | 173 | <td>    |
| 171 | <a href="poller.html#module-eventmq.poller"><code class="xref">eventmq.poller</code></a></td><td> | 174 | <a href="poller.html#module-eventmq.poller"><code class="xref">eventmq.poller</code></a></td><td> |
| 172 | <em></em></td></tr> | 175 | <em></em></td></tr> |
| 173 | <tr class="cg-1"> | 176 | <tr class="cg-1"> |
| 174 | <td></td> | 177 | <td></td> |
| 175 | <td> | 178 | <td>    |
| 176 | <a href="receiver.html#module-eventmq.receiver"><code class="xref">eventmq.receiver</code></a></td><td> | 179 | <a href="receiver.html#module-eventmq.receiver"><code class="xref">eventmq.receiver</code></a></td><td> |
| 177 | <em></em></td></tr> | 180 | <em></em></td></tr> |
| 178 | <tr class="cg-1"> | 181 | <tr class="cg-1"> |
| 179 | <td></td> | 182 | <td></td> |
| 180 | <td> | 183 | <td>    |
| 181 | <a href="router.html#module-eventmq.router"><code class="xref">eventmq.router</code></a></td><td> | 184 | <a href="router.html#module-eventmq.router"><code class="xref">eventmq.router</code></a></td><td> |
| 182 | <em></em></td></tr> | 185 | <em></em></td></tr> |
| 183 | <tr class="cg-1"> | 186 | <tr class="cg-1"> |
| 184 | <td></td> | 187 | <td></td> |
| 185 | <td> | 188 | <td>    |
| 186 | <a href="sender.html#module-eventmq.sender"><code class="xref">eventmq.sender</code></a></td><td> | 189 | <a href="sender.html#module-eventmq.sender"><code class="xref">eventmq.sender</code></a></td><td> |
| 187 | <em></em></td></tr> | 190 | <em></em></td></tr> |
| 188 | <tr class="cg-1"> | 191 | <tr class="cg-1"> |
| 189 | <td></td> | 192 | <td></td> |
| 190 | <td> | 193 | <td>    |
| 191 | <a href="utils/index.html#module-eventmq.utils"><code class="xref">eventmq.utils</code></a></td><td> | 194 | <a href="utils/index.html#module-eventmq.utils"><code class="xref">eventmq.utils</code></a></td><td> |
| 192 | <em></em></td></tr> | 195 | <em></em></td></tr> |
| 193 | <tr class="cg-1"> | 196 | <tr class="cg-1"> |
| 194 | <td></td> | 197 | <td></td> |
| 195 | <td> | 198 | <td>    |
| 196 | <a href="utils/classes.html#module-eventmq.utils.classes"><code class="xref">eventmq.utils.classes</code></a></td><td> | 199 | <a href="utils/classes.html#module-eventmq.utils.classes"><code class="xref">eventmq.utils.classes</code></a></td><td> |
| 197 | <em></em></td></tr> | 200 | <em></em></td></tr> |
| 198 | <tr class="cg-1"> | 201 | <tr class="cg-1"> |
| 199 | <td></td> | 202 | <td></td> |
| 200 | <td> | 203 | <td>    |
| 201 | <a href="utils/devices.html#module-eventmq.utils.devices"><code class="xref">eventmq.utils.devices</code></a></td><td> | 204 | <a href="utils/devices.html#module-eventmq.utils.devices"><code class="xref">eventmq.utils.devices</code></a></td><td> |
| 202 | <em></em></td></tr> | 205 | <em></em></td></tr> |
| 203 | <tr class="cg-1"> | 206 | <tr class="cg-1"> |
| 204 | <td></td> | 207 | <td></td> |
| 205 | <td> | 208 | <td>    |
| 206 | <a href="utils/messages.html#module-eventmq.utils.messages"><code class="xref">eventmq.utils.messages</code></a></td><td> | 209 | <a href="utils/messages.html#module-eventmq.utils.messages"><code class="xref">eventmq.utils.messages</code></a></td><td> |
| 207 | <em></em></td></tr> | 210 | <em></em></td></tr> |
| 208 | <tr class="cg-1"> | 211 | <tr class="cg-1"> |
| 209 | <td></td> | 212 | <td></td> |
| 210 | <td> | 213 | <td>    |
| 211 | <a href="utils/settings.html#module-eventmq.utils.settings"><code class="xref">eventmq.utils.settings</code></a></td><td> | 214 | <a href="utils/settings.html#module-eventmq.utils.settings"><code class="xref">eventmq.utils.settings</code></a></td><td> |
| 212 | <em></em></td></tr> | 215 | <em></em></td></tr> |
| 213 | <tr class="cg-1"> | 216 | <tr class="cg-1"> |
| 214 | <td></td> | 217 | <td></td> |
| 215 | <td> | 218 | <td>    |
| 216 | <a href="utils/timeutils.html#module-eventmq.utils.timeutils"><code class="xref">eventmq.utils.timeutils</code></a></td><td> | 219 | <a href="utils/timeutils.html#module-eventmq.utils.timeutils"><code class="xref">eventmq.utils.timeutils</code></a></td><td> |
| 217 | <em></em></td></tr> | 220 | <em></em></td></tr> |
| 218 | </table> | 221 | </table> |
diff --git a/receiver.html b/receiver.html index 664c268..0f45eba 100644 --- a/receiver.html +++ b/receiver.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="api.html"/> | 37 | <link rel="up" title="API Documentation" href="api.html"/> |
| 35 | <link rel="next" title="router – Router" href="router.html"/> | 38 | <link rel="next" title="router – Router" href="router.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -89,7 +92,7 @@ | |||
| 89 | <li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – 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> – Exceptions</a></li> |
| 90 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> | 93 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> |
| 91 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> | 94 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> |
| 92 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 95 | <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| 93 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 96 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 94 | <li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 97 | <li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</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> – Utilities</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> – Utilities</a></li> |
| @@ -118,7 +121,7 @@ | |||
| 118 | <div class="rst-content"> | 121 | <div class="rst-content"> |
| 119 | 122 | ||
| 120 | 123 | ||
| 121 | 124 | ||
| 122 | 125 | ||
| 123 | 126 | ||
| 124 | 127 | ||
| @@ -158,13 +161,13 @@ | |||
| 158 | <dl class="attribute"> | 161 | <dl class="attribute"> |
| 159 | <dt id="eventmq.receiver.Receiver.zcontext"> | 162 | <dt id="eventmq.receiver.Receiver.zcontext"> |
| 160 | <code class="descname">zcontext</code><a class="headerlink" href="#eventmq.receiver.Receiver.zcontext" title="Permalink to this definition">¶</a></dt> | 163 | <code class="descname">zcontext</code><a class="headerlink" href="#eventmq.receiver.Receiver.zcontext" title="Permalink to this definition">¶</a></dt> |
| 161 | <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> – socket context</p> | 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> – socket context</p> |
| 162 | </dd></dl> | 165 | </dd></dl> |
| 163 | 166 | ||
| 164 | <dl class="attribute"> | 167 | <dl class="attribute"> |
| 165 | <dt id="eventmq.receiver.Receiver.zsocket"> | 168 | <dt id="eventmq.receiver.Receiver.zsocket"> |
| 166 | <code class="descname">zsocket</code><a class="headerlink" href="#eventmq.receiver.Receiver.zsocket" title="Permalink to this definition">¶</a></dt> | 169 | <code class="descname">zsocket</code><a class="headerlink" href="#eventmq.receiver.Receiver.zsocket" title="Permalink to this definition">¶</a></dt> |
| 167 | <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> | 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> |
| 168 | </dd></dl> | 171 | </dd></dl> |
| 169 | 172 | ||
| 170 | <dl class="method"> | 173 | <dl class="method"> |
| @@ -179,11 +182,11 @@ | |||
| 179 | <col class="field-body" /> | 182 | <col class="field-body" /> |
| 180 | <tbody valign="top"> | 183 | <tbody valign="top"> |
| 181 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 184 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 182 | <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>) – name of this socket. By default a uuid will be | 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>) – name of this socket. By default a uuid will be |
| 183 | generated</li> | 186 | generated</li> |
| 184 | <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>) – Context to use when buliding the | 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>) – Context to use when buliding the |
| 185 | socket</li> | 188 | socket</li> |
| 186 | <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>) – Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REP</span></code> or | 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>) – Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REP</span></code> or |
| 187 | <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code>. By default a <cite>ROUTER</cite> is used</li> | 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> |
| 188 | </ul> | 191 | </ul> |
| 189 | </td> | 192 | </td> |
| @@ -203,7 +206,7 @@ socket</li> | |||
| 203 | <col class="field-name" /> | 206 | <col class="field-name" /> |
| 204 | <col class="field-body" /> | 207 | <col class="field-body" /> |
| 205 | <tbody valign="top"> | 208 | <tbody valign="top"> |
| 206 | <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>) – 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/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Address to connect to as a connection string</td> |
| 207 | </tr> | 210 | </tr> |
| 208 | <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-class docutils literal"><span class="pre">Exception</span></code></td> |
| 209 | </tr> | 212 | </tr> |
| @@ -219,7 +222,7 @@ socket</li> | |||
| 219 | <col class="field-name" /> | 222 | <col class="field-name" /> |
| 220 | <col class="field-body" /> | 223 | <col class="field-body" /> |
| 221 | <tbody valign="top"> | 224 | <tbody valign="top"> |
| 222 | <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>) – Address to listen on as a connction string</td> | 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>) – Address to listen on as a connction string</td> |
| 223 | </tr> | 226 | </tr> |
| 224 | <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> | 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> |
| 225 | </tr> | 228 | </tr> |
| @@ -235,10 +238,13 @@ socket</li> | |||
| 235 | <col class="field-name" /> | 238 | <col class="field-name" /> |
| 236 | <col class="field-body" /> | 239 | <col class="field-body" /> |
| 237 | <tbody valign="top"> | 240 | <tbody valign="top"> |
| 238 | <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 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> |
| 239 | False</td> | 242 | <dt>True if the receiver is ready to connect or listen, otherwise</dt> |
| 243 | <dd>False</dd> | ||
| 244 | </dl> | ||
| 245 | </td> | ||
| 240 | </tr> | 246 | </tr> |
| 241 | <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 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> |
| 242 | </tr> | 248 | </tr> |
| 243 | </tbody> | 249 | </tbody> |
| 244 | </table> | 250 | </table> |
| @@ -252,7 +258,7 @@ False</td> | |||
| 252 | <col class="field-name" /> | 258 | <col class="field-name" /> |
| 253 | <col class="field-body" /> | 259 | <col class="field-body" /> |
| 254 | <tbody valign="top"> | 260 | <tbody valign="top"> |
| 255 | <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>) – Address to disconnect from as a string</td> | 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>) – Address to disconnect from as a string</td> |
| 256 | </tr> | 262 | </tr> |
| 257 | <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> | 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> |
| 258 | </tr> | 264 | </tr> |
diff --git a/router.html b/router.html index ca90e13..1d2bb42 100644 --- a/router.html +++ b/router.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="api.html"/> | 37 | <link rel="up" title="API Documentation" href="api.html"/> |
| 35 | <link rel="next" title="sender – Sender" href="sender.html"/> | 38 | <link rel="next" title="sender – Sender" href="sender.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -90,7 +93,7 @@ | |||
| 90 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> | 93 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> |
| 91 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> | 94 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> |
| 92 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 95 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| 93 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 96 | <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 94 | <li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 97 | <li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</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> – Utilities</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> – Utilities</a></li> |
| 96 | </ul> | 99 | </ul> |
| @@ -118,7 +121,7 @@ | |||
| 118 | <div class="rst-content"> | 121 | <div class="rst-content"> |
| 119 | 122 | ||
| 120 | 123 | ||
| 121 | 124 | ||
| 122 | 125 | ||
| 123 | 126 | ||
| 124 | 127 | ||
| @@ -157,7 +160,7 @@ | |||
| 157 | <col class="field-name" /> | 160 | <col class="field-name" /> |
| 158 | <col class="field-body" /> | 161 | <col class="field-body" /> |
| 159 | <tbody valign="top"> | 162 | <tbody valign="top"> |
| 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>) – unique id of the scheduler to add</td> | 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>) – unique id of the scheduler to add</td> |
| 161 | </tr> | 164 | </tr> |
| 162 | </tbody> | 165 | </tbody> |
| 163 | </table> | 166 | </table> |
| @@ -172,7 +175,7 @@ | |||
| 172 | <col class="field-body" /> | 175 | <col class="field-body" /> |
| 173 | <tbody valign="top"> | 176 | <tbody valign="top"> |
| 174 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 177 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 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>) – unique id of the worker to add</li> | 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>) – unique id of the worker to add</li> |
| 176 | <li><strong>queues</strong> – queue or queues this worker should be a member of</li> | 179 | <li><strong>queues</strong> – queue or queues this worker should be a member of</li> |
| 177 | </ul> | 180 | </ul> |
| 178 | </td> | 181 | </td> |
| @@ -204,7 +207,7 @@ queue.</p> | |||
| 204 | <col class="field-name" /> | 207 | <col class="field-name" /> |
| 205 | <col class="field-body" /> | 208 | <col class="field-body" /> |
| 206 | <tbody valign="top"> | 209 | <tbody valign="top"> |
| 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>) – Name of the queue</p> | 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>) – Name of the queue</p> |
| 208 | </td> | 211 | </td> |
| 209 | </tr> | 212 | </tr> |
| 210 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first simple"> | 213 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first simple"> |
| @@ -273,8 +276,8 @@ and announces itself.</p> | |||
| 273 | <col class="field-body" /> | 276 | <col class="field-body" /> |
| 274 | <tbody valign="top"> | 277 | <tbody valign="top"> |
| 275 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 278 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 276 | <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>) – The id of the sender</li> | 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>) – The id of the sender</li> |
| 277 | <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>) – Unique identifier for this message</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>) – Unique identifier for this message</li> |
| 278 | <li><strong>msg</strong> – The actual message that was sent</li> | 281 | <li><strong>msg</strong> – The actual message that was sent</li> |
| 279 | </ul> | 282 | </ul> |
| 280 | </td> | 283 | </td> |
| @@ -302,7 +305,7 @@ measurements</p> | |||
| 302 | <li><strong>sender</strong> – </li> | 305 | <li><strong>sender</strong> – </li> |
| 303 | <li><strong>msgid</strong> – </li> | 306 | <li><strong>msgid</strong> – </li> |
| 304 | <li><strong>msgid</strong> – </li> | 307 | <li><strong>msgid</strong> – </li> |
| 305 | <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>) – The recusion depth in retrying when PeerGoneAwayError | 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>) – The recusion depth in retrying when PeerGoneAwayError |
| 306 | is raised.</li> | 309 | is raised.</li> |
| 307 | </ul> | 310 | </ul> |
| 308 | </td> | 311 | </td> |
| @@ -319,7 +322,7 @@ is raised.</li> | |||
| 319 | <col class="field-name" /> | 322 | <col class="field-name" /> |
| 320 | <col class="field-body" /> | 323 | <col class="field-body" /> |
| 321 | <tbody valign="top"> | 324 | <tbody valign="top"> |
| 322 | <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>) – Any list, tuple, etc where the | 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>) – Any list, tuple, etc where the |
| 323 | 0-index key is an integer to use as priority. Largest numbers | 326 | 0-index key is an integer to use as priority. Largest numbers |
| 324 | come first.</td> | 327 | come first.</td> |
| 325 | </tr> | 328 | </tr> |
| @@ -434,8 +437,8 @@ Contains dictionaries:</p> | |||
| 434 | <col class="field-body" /> | 437 | <col class="field-body" /> |
| 435 | <tbody valign="top"> | 438 | <tbody valign="top"> |
| 436 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 439 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 437 | <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>) – The socket to use for this ack</li> | 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>) – The socket to use for this ack</li> |
| 438 | <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>) – The recipient id for the 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>) – The recipient id for the ack</li> |
| 439 | <li><strong>msgid</strong> – The unique id that we are acknowledging</li> | 442 | <li><strong>msgid</strong> – The unique id that we are acknowledging</li> |
| 440 | </ul> | 443 | </ul> |
| 441 | </td> | 444 | </td> |
| @@ -460,8 +463,8 @@ needed when building messages</p> | |||
| 460 | <col class="field-body" /> | 463 | <col class="field-body" /> |
| 461 | <tbody valign="top"> | 464 | <tbody valign="top"> |
| 462 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 465 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 463 | <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>) – the socket to send the heartbeat with</li> | 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>) – the socket to send the heartbeat with</li> |
| 464 | <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>) – Worker I</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>) – Worker I</li> |
| 465 | </ul> | 468 | </ul> |
| 466 | </td> | 469 | </td> |
| 467 | </tr> | 470 | </tr> |
| @@ -503,9 +506,9 @@ process receives a SIGHUP from the system.</p> | |||
| 503 | <col class="field-body" /> | 506 | <col class="field-body" /> |
| 504 | <tbody valign="top"> | 507 | <tbody valign="top"> |
| 505 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 508 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 506 | <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>) – connection string to listen for requests</li> | 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>) – connection string to listen for requests</li> |
| 507 | <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>) – connection string to listen for workers</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>) – connection string to listen for workers</li> |
| 508 | <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>) – connection string to listen for emq-cli | 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>) – connection string to listen for emq-cli |
| 509 | commands on.</li> | 512 | commands on.</li> |
| 510 | </ul> | 513 | </ul> |
| 511 | </td> | 514 | </td> |
diff --git a/search.html b/search.html index ad81164..de4e383 100644 --- a/search.html +++ b/search.html | |||
| @@ -30,6 +30,9 @@ | |||
| 30 | 30 | ||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | <link rel="index" title="Index" | ||
| 34 | href="genindex.html"/> | ||
| 35 | <link rel="search" title="Search" href="#"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | 37 | ||
| 35 | 38 | ||
| @@ -58,7 +61,7 @@ | |||
| 58 | 61 | ||
| 59 | 62 | ||
| 60 | <div class="version"> | 63 | <div class="version"> |
| 61 | 0.2.6.2 | 64 | 0.2.6.3 |
| 62 | </div> | 65 | </div> |
| 63 | 66 | ||
| 64 | 67 | ||
diff --git a/searchindex.js b/searchindex.js index fb8ebac..9c0e574 100644 --- a/searchindex.js +++ b/searchindex.js | |||
| @@ -1 +1 @@ | |||
| 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,""],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,"_issu":[],"_msg_":8,"_msgid_":8,"_queue_name_":8,"_queues_":8,"_recipient_id":14,"_sourc":[],"_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],activ:[],active_job:[],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,alon:[],alpha:8,alreadi:10,also:14,alwai:2,and_data:17,ani:[2,8,10,16],announc:10,anoth:[6,10,12],anyth:12,api:[],app:14,appear:7,append:14,appendleft:14,appened:10,appli:18,applic:[2,8],architectur:[],aren:[],arg2:2,arg3:2,arg:[2,6,7,9,10,11,14],argument:14,arithmet:19,around:[],arrai:8,ascii:15,assign:12,assum:19,attempt:[4,10],attr:7,automat:14,avail:[4,10],available_slot:10,available_work:[],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],bin:[],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],build_module_path:[],built:8,bulid:9,busi:[],calcul:19,call:[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],column:[],com:[],come:[2,10],comma:8,command:[2,6,8,10,14,17],compar:16,compat:14,complet:8,compon:8,concurr: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],content:[],context:[6,9,11],control:12,contruct:14,convers:8,convert:16,convienc:[7,14],copi:6,core:12,correctli:[],count:[6,8,10,19],counter:[10,14],cpu:12,creat:[10,11,16],cron:2,cross:[],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,decor:[],decrypt:[],decsend:10,def:[],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],did:[],die:10,differ:3,directli:[7,14],disabl:2,disconnect:[],distribut:8,doe:14,doesn:7,don:[6,8],dot:2,down:[12,19],dst:19,duplic:10,dure:11,each:10,easi:[],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,emqp:[],emqpservic:14,enabl:[2,14],encod:15,encount:[2,4],end:[2,14],enderlab:[],ensur:[2,6,8,14],entri:10,equal:12,error:[2,14,15],etc:[10,12],evalu:2,even:8,event:[7,14],eventloop:[],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,filter:[],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,frame:[],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_available_work:10,get_statu:10,github:[],give:2,given:10,gmtime:[],gnu:8,goal:[],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:[],heartbeat:[],heartbeat_timeout:10,heartbeati:14,heartbeatmixin:14,heavi:8,help:12,helper:14,here:[8,10],high:[],highest:12,hit:14,home:[],hope:8,how:[2,7],html:8,http:8,id_:[],ident:[8,15],identifi:10,ietf:8,ignor:[8,14],immedi:[2,8],immediatli:2,implement:[8,14],impli:8,import_set:18,inbetween:[],includ:[2,8,14],incom:[],index:[5,10,16],indexerror:10,indiviud:12,inform:[2,6,8,10,14],inform_typ:[],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_min:[],interval_sec:[2,19],intervalit:19,intes:[],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,keep:[6,10],kei:[7,8,10],keyword:[],kick:[6,10],know:[2,6,10],kwarg2:2,kwarg:[2,6,7,9,10,11,14],languag:[],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,lib:[],licens:[],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,low:[],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,med:[],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,mod:[],mode:[],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],msg_id:[],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],offlin:[],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_receive_repli:[],on_receive_request:[],on_recv:9,on_repli:10,on_request:[6,10],on_schedul:14,onc:8,onli:[],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],overwhelm:[],own:14,packag:[],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,philosophi:[],pictur:8,pip:[],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],primari:[],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,prop:[],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,python2:[],python3:15,python:[6,14],queu:[],queue:[],queue_messag:[],queue_nam:10,quick:[],rais:[2,4,9,10,11,14,17],random:[16,17],random_charact:16,raw:14,raw_messag:[],readi:[6,8,9,10,11,12,14],rebind:10,rebuild:11,rebuilt:6,receiv:[],received_disconnect:10,recent:[8,10],reciev:[],recip:[],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:[],request_queu:[],requeue_work:10,requir:8,requri:[],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_kby:[],send_messag:[],send_multipart:14,send_raw:[],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,serv:8,server:[6,8,12],servic:[8,14],service_typ:14,set:[],setup:[],shall:8,shalt:[],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],site:[],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:[],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,sub:8,subclass:4,subcmd:6,subcommand:[2,6],subject:8,subsequ:[],subset:8,subtract:19,success:8,successfulli:14,support:14,system:[3,10],take:[10,11,14,15,17],taken:[],task:[2,6],tcp:10,tell:6,term:8,termin:6,test:6,than:[],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,thou:[],thread:12,threshold:14,through:[8,10],thy:[],time:[],timeout:7,timestamp:[8,10,19],timeutil:[],timezon:[],tip:3,tool:8,topic:8,topolog:[],tornado:[],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,uint:[],unabl:10,unbind:[9,11],undefin:7,under:8,unicod:15,uniqu:[6,8,10],unit:6,univers:[],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,utilit:[],utlitii:14,uuid:[6,9,10,11],vagrant:[],valid:8,valu:[2,7,8,10,14,16,17,19],valueerror:14,variabl:14,version:[3,8,14],via:[2,19],virtualenv:[],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,went:[],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:[],wrong:[],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> – Client Utilities","<code class=\"docutils literal\"><span class=\"pre\">messages</span></code> – Client Messaging","Contributing to EventMQ","<code class=\"docutils literal\"><span class=\"pre\">exceptions</span></code> – Exceptions","EventMQ Documentation","<code class=\"docutils literal\"><span class=\"pre\">jobmanager</span></code> – Job Manager","<code class=\"docutils literal\"><span class=\"pre\">poller</span></code> – Poller","EventMQ Protocol Specification","<code class=\"docutils literal\"><span class=\"pre\">receiver</span></code> – Receiver","<code class=\"docutils literal\"><span class=\"pre\">router</span></code> – Router","<code class=\"docutils literal\"><span class=\"pre\">sender</span></code> – Sender","Settings","Using EventMQ","<code class=\"docutils literal\"><span class=\"pre\">classes</span></code> – Utility Classes","<code class=\"docutils literal\"><span class=\"pre\">devices</span></code> – Device Utilities","<code class=\"docutils literal\"><span class=\"pre\">utils</span></code> – Utilities","<code class=\"docutils literal\"><span class=\"pre\">messages</span></code> – Message Utilities","<code class=\"docutils literal\"><span class=\"pre\">settings</span></code> – Settings Utilities","<code class=\"docutils literal\"><span class=\"pre\">timeutils</span></code> – 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,get:[],global:8,glossari:[],goal:8,guid:[],header:8,heartbeat:8,indic:5,job:[6,12],jobmanag:6,kbai:8,languag:8,licens:8,manag:[6,12],messag:[2,17],mod:[],poller:7,protocol:8,queue:12,receiv:9,request:[],router:[8,10,12],schedul:[8,12],sender:11,set:[12,18],specif:8,start:[],style:[],tabl:5,time:19,timeutil:19,topolog:8,util:[1,14,15,16,17,18],utilit:19,welcom:[],worker:8}}) \ No newline at end of file | 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> – Client Utilities","<code class=\"docutils literal\"><span class=\"pre\">messages</span></code> – Client Messaging","Contributing to EventMQ","<code class=\"docutils literal\"><span class=\"pre\">exceptions</span></code> – Exceptions","EventMQ Documentation","<code class=\"docutils literal\"><span class=\"pre\">jobmanager</span></code> – Job Manager","<code class=\"docutils literal\"><span class=\"pre\">poller</span></code> – Poller","EventMQ Protocol Specification","<code class=\"docutils literal\"><span class=\"pre\">receiver</span></code> – Receiver","<code class=\"docutils literal\"><span class=\"pre\">router</span></code> – Router","<code class=\"docutils literal\"><span class=\"pre\">sender</span></code> – Sender","Settings","Using EventMQ","<code class=\"docutils literal\"><span class=\"pre\">classes</span></code> – Utility Classes","<code class=\"docutils literal\"><span class=\"pre\">devices</span></code> – Device Utilities","<code class=\"docutils literal\"><span class=\"pre\">utils</span></code> – Utilities","<code class=\"docutils literal\"><span class=\"pre\">messages</span></code> – Message Utilities","<code class=\"docutils literal\"><span class=\"pre\">settings</span></code> – Settings Utilities","<code class=\"docutils literal\"><span class=\"pre\">timeutils</span></code> – 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 | ||
diff --git a/sender.html b/sender.html index d5d3234..976d996 100644 --- a/sender.html +++ b/sender.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="api.html"/> | 37 | <link rel="up" title="API Documentation" href="api.html"/> |
| 35 | <link rel="next" title="utils – Utilities" href="utils/index.html"/> | 38 | <link rel="next" title="utils – Utilities" href="utils/index.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -91,7 +94,7 @@ | |||
| 91 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> | 94 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> |
| 92 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 95 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| 93 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 96 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 94 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 97 | <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</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> – Utilities</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> – Utilities</a></li> |
| 96 | </ul> | 99 | </ul> |
| 97 | </li> | 100 | </li> |
| @@ -118,7 +121,7 @@ | |||
| 118 | <div class="rst-content"> | 121 | <div class="rst-content"> |
| 119 | 122 | ||
| 120 | 123 | ||
| 121 | 124 | ||
| 122 | 125 | ||
| 123 | 126 | ||
| 124 | 127 | ||
| @@ -158,13 +161,13 @@ | |||
| 158 | <dl class="attribute"> | 161 | <dl class="attribute"> |
| 159 | <dt id="eventmq.sender.Sender.zcontext"> | 162 | <dt id="eventmq.sender.Sender.zcontext"> |
| 160 | <code class="descname">zcontext</code><a class="headerlink" href="#eventmq.sender.Sender.zcontext" title="Permalink to this definition">¶</a></dt> | 163 | <code class="descname">zcontext</code><a class="headerlink" href="#eventmq.sender.Sender.zcontext" title="Permalink to this definition">¶</a></dt> |
| 161 | <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> – socket context</p> | 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> – socket context</p> |
| 162 | </dd></dl> | 165 | </dd></dl> |
| 163 | 166 | ||
| 164 | <dl class="attribute"> | 167 | <dl class="attribute"> |
| 165 | <dt id="eventmq.sender.Sender.zsocket"> | 168 | <dt id="eventmq.sender.Sender.zsocket"> |
| 166 | <code class="descname">zsocket</code><a class="headerlink" href="#eventmq.sender.Sender.zsocket" title="Permalink to this definition">¶</a></dt> | 169 | <code class="descname">zsocket</code><a class="headerlink" href="#eventmq.sender.Sender.zsocket" title="Permalink to this definition">¶</a></dt> |
| 167 | <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> | 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> |
| 168 | </dd></dl> | 171 | </dd></dl> |
| 169 | 172 | ||
| 170 | <dl class="method"> | 173 | <dl class="method"> |
| @@ -179,13 +182,13 @@ | |||
| 179 | <col class="field-body" /> | 182 | <col class="field-body" /> |
| 180 | <tbody valign="top"> | 183 | <tbody valign="top"> |
| 181 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 184 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 182 | <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>) – name of this socket. By default a uuid will be | 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>) – name of this socket. By default a uuid will be |
| 183 | generated</li> | 186 | generated</li> |
| 184 | <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>) – Context to use when building the | 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>) – Context to use when building the |
| 185 | socket</li> | 188 | socket</li> |
| 186 | <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>) – Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REQ</span></code> or | 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>) – Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REQ</span></code> or |
| 187 | <code class="xref py py-attr docutils literal"><span class="pre">zmq.DEALER</span></code>. By default a <cite>DEALER</cite> is used</li> | 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> |
| 188 | <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>) – If set to true, skip creating the zmqstream | 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>) – If set to true, skip creating the zmqstream |
| 189 | socket</li> | 192 | socket</li> |
| 190 | </ul> | 193 | </ul> |
| 191 | </td> | 194 | </td> |
| @@ -202,7 +205,7 @@ socket</li> | |||
| 202 | <col class="field-name" /> | 205 | <col class="field-name" /> |
| 203 | <col class="field-body" /> | 206 | <col class="field-body" /> |
| 204 | <tbody valign="top"> | 207 | <tbody valign="top"> |
| 205 | <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>) – Address to connect to as a connection string</td> | 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>) – Address to connect to as a connection string</td> |
| 206 | </tr> | 209 | </tr> |
| 207 | <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> | 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> |
| 208 | </tr> | 211 | </tr> |
| @@ -218,7 +221,7 @@ socket</li> | |||
| 218 | <col class="field-name" /> | 221 | <col class="field-name" /> |
| 219 | <col class="field-body" /> | 222 | <col class="field-body" /> |
| 220 | <tbody valign="top"> | 223 | <tbody valign="top"> |
| 221 | <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>) – 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/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Address to listen on as a connction string</td> |
| 222 | </tr> | 225 | </tr> |
| 223 | <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-class docutils literal"><span class="pre">Exception</span></code></td> |
| 224 | </tr> | 227 | </tr> |
| @@ -234,10 +237,13 @@ socket</li> | |||
| 234 | <col class="field-name" /> | 237 | <col class="field-name" /> |
| 235 | <col class="field-body" /> | 238 | <col class="field-body" /> |
| 236 | <tbody valign="top"> | 239 | <tbody valign="top"> |
| 237 | <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 | 240 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> |
| 238 | False</td> | 241 | <dt>True if the receiver is ready to connect or listen, otherwise</dt> |
| 242 | <dd>False</dd> | ||
| 243 | </dl> | ||
| 244 | </td> | ||
| 239 | </tr> | 245 | </tr> |
| 240 | <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> | 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> |
| 241 | </tr> | 247 | </tr> |
| 242 | </tbody> | 248 | </tbody> |
| 243 | </table> | 249 | </table> |
| @@ -255,9 +261,9 @@ parameters as <code class="xref py py-meth docutils literal"><span class="pre">s | |||
| 255 | <col class="field-body" /> | 261 | <col class="field-body" /> |
| 256 | <tbody valign="top"> | 262 | <tbody valign="top"> |
| 257 | <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 last simple"> |
| 258 | <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>) – Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REQ</span></code> or | 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>) – Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REQ</span></code> or |
| 259 | <code class="xref py py-attr docutils literal"><span class="pre">zmq.DEALER</span></code>. By default a <cite>DEALER</cite> is used</li> | 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> |
| 260 | <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>) – If set to true, skip creating the zmqstream | 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>) – If set to true, skip creating the zmqstream |
| 261 | socket</li> | 267 | socket</li> |
| 262 | </ul> | 268 | </ul> |
| 263 | </td> | 269 | </td> |
| @@ -274,7 +280,7 @@ socket</li> | |||
| 274 | <col class="field-name" /> | 280 | <col class="field-name" /> |
| 275 | <col class="field-body" /> | 281 | <col class="field-body" /> |
| 276 | <tbody valign="top"> | 282 | <tbody valign="top"> |
| 277 | <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>) – Address to unbind from as a string</td> | 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>) – Address to unbind from as a string</td> |
| 278 | </tr> | 284 | </tr> |
| 279 | <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> | 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> |
| 280 | </tr> | 286 | </tr> |
diff --git a/settings_file.html b/settings_file.html index 290a57e..9133384 100644 --- a/settings_file.html +++ b/settings_file.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="Using EventMQ" href="using.html"/> | 37 | <link rel="up" title="Using EventMQ" href="using.html"/> |
| 35 | <link rel="next" title="API Documentation" href="api.html"/> | 38 | <link rel="next" title="API Documentation" href="api.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -84,7 +87,7 @@ | |||
| 84 | 87 | ||
| 85 | <ul class="current"> | 88 | <ul class="current"> |
| 86 | <li class="toctree-l1 current"><a class="reference internal" href="using.html">Using EventMQ</a><ul class="current"> | 89 | <li class="toctree-l1 current"><a class="reference internal" href="using.html">Using EventMQ</a><ul class="current"> |
| 87 | <li class="toctree-l2 current"><a class="current reference internal" href="">Settings</a><ul> | 90 | <li class="toctree-l2 current"><a class="current reference internal" href="#">Settings</a><ul> |
| 88 | <li class="toctree-l3"><a class="reference internal" href="#router">Router</a></li> | 91 | <li class="toctree-l3"><a class="reference internal" href="#router">Router</a></li> |
| 89 | <li class="toctree-l3"><a class="reference internal" href="#scheduler">Scheduler</a></li> | 92 | <li class="toctree-l3"><a class="reference internal" href="#scheduler">Scheduler</a></li> |
| 90 | <li class="toctree-l3"><a class="reference internal" href="#job-manager">Job Manager</a><ul> | 93 | <li class="toctree-l3"><a class="reference internal" href="#job-manager">Job Manager</a><ul> |
| @@ -120,7 +123,7 @@ | |||
| 120 | <div class="rst-content"> | 123 | <div class="rst-content"> |
| 121 | 124 | ||
| 122 | 125 | ||
| 123 | 126 | ||
| 124 | 127 | ||
| 125 | 128 | ||
| 126 | 129 | ||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="next" title="Settings" href="settings_file.html"/> | 37 | <link rel="next" title="Settings" href="settings_file.html"/> |
| 35 | <link rel="prev" title="EventMQ Documentation" href="index.html"/> | 38 | <link rel="prev" title="EventMQ Documentation" href="index.html"/> |
| @@ -60,7 +63,7 @@ | |||
| 60 | 63 | ||
| 61 | 64 | ||
| 62 | <div class="version"> | 65 | <div class="version"> |
| 63 | 0.2.6.2 | 66 | 0.2.6.3 |
| 64 | </div> | 67 | </div> |
| 65 | 68 | ||
| 66 | 69 | ||
| @@ -82,7 +85,7 @@ | |||
| 82 | 85 | ||
| 83 | 86 | ||
| 84 | <ul class="current"> | 87 | <ul class="current"> |
| 85 | <li class="toctree-l1 current"><a class="current reference internal" href="">Using EventMQ</a><ul> | 88 | <li class="toctree-l1 current"><a class="current reference internal" href="#">Using EventMQ</a><ul> |
| 86 | <li class="toctree-l2"><a class="reference internal" href="settings_file.html">Settings</a></li> | 89 | <li class="toctree-l2"><a class="reference internal" href="settings_file.html">Settings</a></li> |
| 87 | </ul> | 90 | </ul> |
| 88 | </li> | 91 | </li> |
| @@ -110,7 +113,7 @@ | |||
| 110 | <div class="rst-content"> | 113 | <div class="rst-content"> |
| 111 | 114 | ||
| 112 | 115 | ||
| 113 | 116 | ||
| 114 | 117 | ||
| 115 | 118 | ||
| 116 | 119 | ||
diff --git a/utils/classes.html b/utils/classes.html index e0ca5eb..9f055f2 100644 --- a/utils/classes.html +++ b/utils/classes.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils – Utilities" href="index.html"/> | 37 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="devices – Device Utilities" href="devices.html"/> | 38 | <link rel="next" title="devices – Device Utilities" href="devices.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -93,7 +96,7 @@ | |||
| 93 | <li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 96 | <li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 94 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 97 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> |
| 95 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> | 98 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> |
| 96 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 99 | <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> |
| 97 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device Utilities</a></li> | 100 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device 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> – Message 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> – Message 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> – Settings 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> – Settings Utilities</a></li> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -235,8 +238,8 @@ for.</p> | |||
| 235 | <col class="field-body" /> | 238 | <col class="field-body" /> |
| 236 | <tbody valign="top"> | 239 | <tbody valign="top"> |
| 237 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 240 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 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>) – Either ‘worker’ or ‘scheduler’</li> | 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>) – Either ‘worker’ or ‘scheduler’</li> |
| 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>) – <ul> | 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>) – <ul> |
| 240 | <li>For ‘worker’ type, the queues the worker is listening on and | 243 | <li>For ‘worker’ type, the queues the worker is listening on and |
| 241 | their weights.<dl class="docutils"> | 244 | their weights.<dl class="docutils"> |
| 242 | <dt>Example:</dt> | 245 | <dt>Example:</dt> |
| @@ -255,7 +258,7 @@ their weights.<dl class="docutils"> | |||
| 255 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> | 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 | </td> | 259 | </td> |
| 257 | </tr> | 260 | </tr> |
| 258 | <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> | 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 | </td> | 262 | </td> |
| 260 | </tr> | 263 | </tr> |
| 261 | </tbody> | 264 | </tbody> |
| @@ -275,7 +278,7 @@ compatibility and not recommended for new apps.</p> | |||
| 275 | <col class="field-name" /> | 278 | <col class="field-name" /> |
| 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"><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>) – connection string to connect to</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/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – connection string to connect to</td> |
| 279 | </tr> | 282 | </tr> |
| 280 | </tbody> | 283 | </tbody> |
| 281 | </table> | 284 | </table> |
| @@ -302,12 +305,12 @@ checked to ensure proper error handling.</p> | |||
| 302 | <col class="field-body" /> | 305 | <col class="field-body" /> |
| 303 | <tbody valign="top"> | 306 | <tbody valign="top"> |
| 304 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 307 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 305 | <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>) – Hard limit on deque size. Rejects adding elements. | 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>) – Hard limit on deque size. Rejects adding elements. |
| 306 | Default: 0 - no limit</li> | 309 | Default: 0 - no limit</li> |
| 307 | <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>) – Programmable limit on deque size, defaults | 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>) – Programmable limit on deque size, defaults |
| 308 | to <code class="docutils literal"><span class="pre">full</span></code> length</li> | 311 | to <code class="docutils literal"><span class="pre">full</span></code> length</li> |
| 309 | <li><strong>on_full</strong> (<em>func</em>) – callback to call when <code class="docutils literal"><span class="pre">full</span></code> limit is hit</li> | 312 | <li><strong>on_full</strong> (<em>func</em>) – callback to call when <code class="docutils literal"><span class="pre">full</span></code> limit is hit</li> |
| 310 | <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>) – The initial iteratable used to contruct the deque</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>) – The initial iteratable used to contruct the deque</li> |
| 311 | </ul> | 314 | </ul> |
| 312 | </td> | 315 | </td> |
| 313 | </tr> | 316 | </tr> |
| @@ -334,11 +337,14 @@ where False is returned.</p> | |||
| 334 | <col class="field-name" /> | 337 | <col class="field-name" /> |
| 335 | <col class="field-body" /> | 338 | <col class="field-body" /> |
| 336 | <tbody valign="top"> | 339 | <tbody valign="top"> |
| 337 | <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 | 340 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> |
| 338 | 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 | 341 | <dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> |
| 339 | called.</td> | 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 |
| 343 | called.</dd> | ||
| 344 | </dl> | ||
| 345 | </td> | ||
| 340 | </tr> | 346 | </tr> |
| 341 | <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> | 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> | 348 | </tr> |
| 343 | </tbody> | 349 | </tbody> |
| 344 | </table> | 350 | </table> |
| @@ -357,11 +363,14 @@ where False is returned.</p> | |||
| 357 | <col class="field-name" /> | 363 | <col class="field-name" /> |
| 358 | <col class="field-body" /> | 364 | <col class="field-body" /> |
| 359 | <tbody valign="top"> | 365 | <tbody valign="top"> |
| 360 | <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 | 366 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> |
| 361 | 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 | 367 | <dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> |
| 362 | called.</td> | 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 |
| 369 | called.</dd> | ||
| 370 | </dl> | ||
| 371 | </td> | ||
| 363 | </tr> | 372 | </tr> |
| 364 | <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> | 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> | 374 | </tr> |
| 366 | </tbody> | 375 | </tbody> |
| 367 | </table> | 376 | </table> |
| @@ -375,11 +384,14 @@ called.</td> | |||
| 375 | <col class="field-name" /> | 384 | <col class="field-name" /> |
| 376 | <col class="field-body" /> | 385 | <col class="field-body" /> |
| 377 | <tbody valign="top"> | 386 | <tbody valign="top"> |
| 378 | <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 | 387 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> |
| 379 | 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 | 388 | <dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> |
| 380 | called.</td> | 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 |
| 390 | called.</dd> | ||
| 391 | </dl> | ||
| 392 | </td> | ||
| 381 | </tr> | 393 | </tr> |
| 382 | <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> | 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> | 395 | </tr> |
| 384 | </tbody> | 396 | </tbody> |
| 385 | </table> | 397 | </table> |
| @@ -395,7 +407,7 @@ called.</td> | |||
| 395 | <tbody valign="top"> | 407 | <tbody valign="top"> |
| 396 | <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> | 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> | 409 | </tr> |
| 398 | <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> | 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> | 411 | </tr> |
| 400 | </tbody> | 412 | </tbody> |
| 401 | </table> | 413 | </table> |
| @@ -412,7 +424,7 @@ called.</td> | |||
| 412 | <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 | 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 | otherwise</td> | 425 | otherwise</td> |
| 414 | </tr> | 426 | </tr> |
| 415 | <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> | 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> | 428 | </tr> |
| 417 | </tbody> | 429 | </tbody> |
| 418 | </table> | 430 | </table> |
| @@ -429,7 +441,7 @@ otherwise</td> | |||
| 429 | <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. | 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 | False otherwise</td> | 442 | False otherwise</td> |
| 431 | </tr> | 443 | </tr> |
| 432 | <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> | 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> | 445 | </tr> |
| 434 | </tbody> | 446 | </tbody> |
| 435 | </table> | 447 | </table> |
| @@ -444,7 +456,7 @@ False otherwise</td> | |||
| 444 | <tbody valign="top"> | 456 | <tbody valign="top"> |
| 445 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td> | 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> |
| 446 | </tr> | 458 | </tr> |
| 447 | <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> | 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> |
| 448 | </tr> | 460 | </tr> |
| 449 | </tbody> | 461 | </tbody> |
| 450 | </table> | 462 | </table> |
| @@ -459,7 +471,7 @@ False otherwise</td> | |||
| 459 | <tbody valign="top"> | 471 | <tbody valign="top"> |
| 460 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td> | 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> |
| 461 | </tr> | 473 | </tr> |
| 462 | <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> | 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> |
| 463 | </tr> | 475 | </tr> |
| 464 | </tbody> | 476 | </tbody> |
| 465 | </table> | 477 | </table> |
| @@ -473,7 +485,7 @@ False otherwise</td> | |||
| 473 | <col class="field-name" /> | 485 | <col class="field-name" /> |
| 474 | <col class="field-body" /> | 486 | <col class="field-body" /> |
| 475 | <tbody valign="top"> | 487 | <tbody valign="top"> |
| 476 | <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>) – The item to remove from the deque</td> | 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>) – The item to remove from the deque</td> |
| 477 | </tr> | 489 | </tr> |
| 478 | </tbody> | 490 | </tbody> |
| 479 | </table> | 491 | </table> |
| @@ -506,14 +518,17 @@ met.</p> | |||
| 506 | <col class="field-name" /> | 518 | <col class="field-name" /> |
| 507 | <col class="field-body" /> | 519 | <col class="field-body" /> |
| 508 | <tbody valign="top"> | 520 | <tbody valign="top"> |
| 509 | <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>) – The time to use to check if death has occurred. If | 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>) – The time to use to check if death has occurred. If |
| 510 | this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code> | 522 | this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code> |
| 511 | is used.</td> | 523 | is used.</td> |
| 512 | </tr> | 524 | </tr> |
| 513 | <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 | 525 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> |
| 514 | False</td> | 526 | <dt>True if the connection to the peer has died, otherwise</dt> |
| 527 | <dd>False</dd> | ||
| 528 | </dl> | ||
| 529 | </td> | ||
| 515 | </tr> | 530 | </tr> |
| 516 | <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> | 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> |
| 517 | </tr> | 532 | </tr> |
| 518 | </tbody> | 533 | </tbody> |
| 519 | </table> | 534 | </table> |
| @@ -533,11 +548,11 @@ False</td> | |||
| 533 | <col class="field-name" /> | 548 | <col class="field-name" /> |
| 534 | <col class="field-body" /> | 549 | <col class="field-body" /> |
| 535 | <tbody valign="top"> | 550 | <tbody valign="top"> |
| 536 | <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>) – The eMQP socket to send the message to</td> | 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>) – The eMQP socket to send the message to</td> |
| 537 | </tr> | 552 | </tr> |
| 538 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td> | 553 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td> |
| 539 | </tr> | 554 | </tr> |
| 540 | <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> | 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> |
| 541 | </tr> | 556 | </tr> |
| 542 | </tbody> | 557 | </tbody> |
| 543 | </table> | 558 | </table> |
| @@ -591,7 +606,7 @@ on it’s own</p> | |||
| 591 | <tbody valign="top"> | 606 | <tbody valign="top"> |
| 592 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 607 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 593 | <li><strong>message</strong> – message to send to something</li> | 608 | <li><strong>message</strong> – message to send to something</li> |
| 594 | <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>) – protocol version. it’s good practice, but | 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>) – protocol version. it’s good practice, but |
| 595 | you may explicitly specify None to skip adding the version</li> | 610 | you may explicitly specify None to skip adding the version</li> |
| 596 | </ul> | 611 | </ul> |
| 597 | </td> | 612 | </td> |
| @@ -613,10 +628,10 @@ like this</p> | |||
| 613 | <col class="field-body" /> | 628 | <col class="field-body" /> |
| 614 | <tbody valign="top"> | 629 | <tbody valign="top"> |
| 615 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 630 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 616 | <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>) – Raw message to send.</li> | 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>) – Raw message to send.</li> |
| 617 | <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>) – protocol version. it’s good practice but | 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>) – protocol version. it’s good practice but |
| 618 | you may explicitly specify None to skip adding the version</li> | 633 | you may explicitly specify None to skip adding the version</li> |
| 619 | <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>) – When using a <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code> you must | 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>) – When using a <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code> you must |
| 620 | specify the the recipient id of the remote socket</li> | 635 | specify the the recipient id of the remote socket</li> |
| 621 | </ul> | 636 | </ul> |
| 622 | </td> | 637 | </td> |
diff --git a/utils/devices.html b/utils/devices.html index 89baede..bd246de 100644 --- a/utils/devices.html +++ b/utils/devices.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils – Utilities" href="index.html"/> | 37 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="messages – Message Utilities" href="messages.html"/> | 38 | <link rel="next" title="messages – Message Utilities" href="messages.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -94,7 +97,7 @@ | |||
| 94 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 97 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> |
| 95 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> | 98 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> |
| 96 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 99 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> |
| 97 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">devices</span></code> – Device Utilities</a></li> | 100 | <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">devices</span></code> – Device 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> – Message 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> – Message 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> – Settings 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> – Settings Utilities</a></li> |
| 100 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> | 103 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -162,7 +165,7 @@ causes errors when setting the IDENTITY of the ZMQ socket.</p> | |||
| 162 | <col class="field-name" /> | 165 | <col class="field-name" /> |
| 163 | <col class="field-body" /> | 166 | <col class="field-body" /> |
| 164 | <tbody valign="top"> | 167 | <tbody valign="top"> |
| 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>) – Prefix the id with this string.</td> | 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>) – Prefix the id with this string.</td> |
| 166 | </tr> | 169 | </tr> |
| 167 | </tbody> | 170 | </tbody> |
| 168 | </table> | 171 | </table> |
diff --git a/utils/index.html b/utils/index.html index 65c0c92..386ef87 100644 --- a/utils/index.html +++ b/utils/index.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="../api.html"/> | 37 | <link rel="up" title="API Documentation" href="../api.html"/> |
| 35 | <link rel="next" title="classes – Utility Classes" href="classes.html"/> | 38 | <link rel="next" title="classes – Utility Classes" href="classes.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -92,7 +95,7 @@ | |||
| 92 | <li class="toctree-l2"><a class="reference internal" href="../receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 95 | <li class="toctree-l2"><a class="reference internal" href="../receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| 93 | <li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 96 | <li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 94 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 97 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> |
| 95 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul> | 98 | <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul> |
| 96 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 99 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> |
| 97 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device Utilities</a></li> | 100 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device 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> – Message 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> – Message Utilities</a></li> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -171,7 +174,7 @@ like creating message more simple.</p> | |||
| 171 | <tbody valign="top"> | 174 | <tbody valign="top"> |
| 172 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">some random characters of a specified length</td> | 175 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">some random characters of a specified length</td> |
| 173 | </tr> | 176 | </tr> |
| 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> | 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> |
| 175 | </tr> | 178 | </tr> |
| 176 | </tbody> | 179 | </tbody> |
| 177 | </table> | 180 | </table> |
| @@ -185,7 +188,7 @@ like creating message more simple.</p> | |||
| 185 | <col class="field-name" /> | 188 | <col class="field-name" /> |
| 186 | <col class="field-body" /> | 189 | <col class="field-body" /> |
| 187 | <tbody valign="top"> | 190 | <tbody valign="top"> |
| 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>) – any value of interest</td> | 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>) – any value of interest</td> |
| 189 | </tr> | 192 | </tr> |
| 190 | </tbody> | 193 | </tbody> |
| 191 | </table> | 194 | </table> |
diff --git a/utils/messages.html b/utils/messages.html index 8f06b99..8c09dc5 100644 --- a/utils/messages.html +++ b/utils/messages.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils – Utilities" href="index.html"/> | 37 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="settings – Settings Utilities" href="settings.html"/> | 38 | <link rel="next" title="settings – Settings Utilities" href="settings.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -95,7 +98,7 @@ | |||
| 95 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> | 98 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> |
| 96 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 99 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> |
| 97 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device Utilities</a></li> | 100 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device 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> – Message 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> – Message 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> – Settings 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> – Settings Utilities</a></li> |
| 100 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> | 103 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> |
| 101 | </ul> | 104 | </ul> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -163,8 +166,8 @@ | |||
| 163 | <tbody valign="top"> | 166 | <tbody valign="top"> |
| 164 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 167 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 165 | <li><strong>socket</strong> – socket to send the message with</li> | 168 | <li><strong>socket</strong> – socket to send the message with</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>) – the id of the connected device to reply to</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>) – the id of the connected device to reply to</li> |
| 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>) – The message to send. The first frame should be an | 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>) – The message to send. The first frame should be an |
| 168 | empty string</li> | 171 | empty string</li> |
| 169 | </ul> | 172 | </ul> |
| 170 | </td> | 173 | </td> |
| @@ -182,7 +185,7 @@ be prefixed with <cite>prefix</cite>.</p> | |||
| 182 | <col class="field-name" /> | 185 | <col class="field-name" /> |
| 183 | <col class="field-body" /> | 186 | <col class="field-body" /> |
| 184 | <tbody valign="top"> | 187 | <tbody valign="top"> |
| 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>) – Value to prefix on to the random part of the id. Useful | 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>) – Value to prefix on to the random part of the id. Useful |
| 186 | for prefixing some meta data to use for things</td> | 189 | for prefixing some meta data to use for things</td> |
| 187 | </tr> | 190 | </tr> |
| 188 | </tbody> | 191 | </tbody> |
| @@ -245,7 +248,7 @@ parts.</p> | |||
| 245 | <tbody valign="top"> | 248 | <tbody valign="top"> |
| 246 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td> | 249 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td> |
| 247 | </tr> | 250 | </tr> |
| 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> | 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> |
| 249 | </tr> | 252 | </tr> |
| 250 | </tbody> | 253 | </tbody> |
| 251 | </table> | 254 | </table> |
| @@ -262,8 +265,8 @@ used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.R | |||
| 262 | <tbody valign="top"> | 265 | <tbody valign="top"> |
| 263 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 266 | <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> – socket to send the message with</li> | 267 | <li><strong>socket</strong> – socket to send the message with</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>) – the id of the connected device to reply to</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>) – the id of the connected device to reply to</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>) – the eMQP command to send</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>) – the eMQP command to send</li> |
| 267 | <li><strong>message</strong> – a msg tuple to send</li> | 270 | <li><strong>message</strong> – a msg tuple to send</li> |
| 268 | </ul> | 271 | </ul> |
| 269 | </td> | 272 | </td> |
diff --git a/utils/settings.html b/utils/settings.html index 57e912c..0e4a7b4 100644 --- a/utils/settings.html +++ b/utils/settings.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils – Utilities" href="index.html"/> | 37 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="timeutils – Time Utilites" href="timeutils.html"/> | 38 | <link rel="next" title="timeutils – Time Utilites" href="timeutils.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -96,7 +99,7 @@ | |||
| 96 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 99 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> |
| 97 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device Utilities</a></li> | 100 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device 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> – Message 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> – Message 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> – Settings 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> – Settings Utilities</a></li> |
| 100 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> | 103 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> |
| 101 | </ul> | 104 | </ul> |
| 102 | </li> | 105 | </li> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -161,7 +164,7 @@ | |||
| 161 | <col class="field-name" /> | 164 | <col class="field-name" /> |
| 162 | <col class="field-body" /> | 165 | <col class="field-body" /> |
| 163 | <tbody valign="top"> | 166 | <tbody valign="top"> |
| 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>) – Name of the INI section to import</td> | 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>) – Name of the INI section to import</td> |
| 165 | </tr> | 168 | </tr> |
| 166 | </tbody> | 169 | </tbody> |
| 167 | </table> | 170 | </table> |
diff --git a/utils/timeutils.html b/utils/timeutils.html index 8003f70..388cac5 100644 --- a/utils/timeutils.html +++ b/utils/timeutils.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils – Utilities" href="index.html"/> | 37 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="Contributing to EventMQ" href="../contributing.html"/> | 38 | <link rel="next" title="Contributing to EventMQ" href="../contributing.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.6.2 | 67 | 0.2.6.3 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -97,7 +100,7 @@ | |||
| 97 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device Utilities</a></li> | 100 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device 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> – Message 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> – Message 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> – Settings 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> – Settings Utilities</a></li> |
| 100 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> | 103 | <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> |
| 101 | </ul> | 104 | </ul> |
| 102 | </li> | 105 | </li> |
| 103 | </ul> | 106 | </ul> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -179,7 +182,7 @@ next(interval) # 600</p> | |||
| 179 | <tbody valign="top"> | 182 | <tbody valign="top"> |
| 180 | <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"> |
| 181 | <li><strong>start_value</strong> (<em>numeric</em>) – 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> | 184 | <li><strong>start_value</strong> (<em>numeric</em>) – 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> |
| 182 | <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>) – </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>) – </li> |
| 183 | </ul> | 186 | </ul> |
| 184 | </td> | 187 | </td> |
| 185 | </tr> | 188 | </tr> |