From d04b9708d570bb227aeff7725af8ebbf15dac3e1 Mon Sep 17 00:00:00 2001 From: jason Date: Mon, 23 Nov 2015 20:30:11 -0700 Subject: updates --- _sources/api.txt | 3 +- _sources/contributing.txt | 4 + _sources/poller.txt | 3 + _sources/protocol.txt | 13 ++ _sources/utils/classes.txt | 3 + _sources/utils/messages.txt | 3 + api.html | 16 ++- contributing.html | 6 + genindex.html | 105 +++++++++++++-- index.html | 3 +- jobmanager.html | 33 +++-- objects.inv | Bin 582 -> 726 bytes poller.html | 284 +++++++++++++++++++++++++++++++++++++++++ protocol.html | 36 ++++++ py-modindex.html | 15 +++ receiver.html | 13 +- router.html | 13 +- searchindex.js | 2 +- sender.html | 68 +--------- utils.html | 41 +++--- utils/classes.html | 304 ++++++++++++++++++++++++++++++++++++++++++++ utils/messages.html | 301 +++++++++++++++++++++++++++++++++++++++++++ 22 files changed, 1136 insertions(+), 133 deletions(-) create mode 100644 _sources/poller.txt create mode 100644 _sources/utils/classes.txt create mode 100644 _sources/utils/messages.txt create mode 100644 poller.html create mode 100644 utils/classes.html create mode 100644 utils/messages.html diff --git a/_sources/api.txt b/_sources/api.txt index b0ecf4e..b3cdc83 100644 --- a/_sources/api.txt +++ b/_sources/api.txt @@ -5,9 +5,10 @@ API Documentation .. toctree:: :maxdepth: 2 + exceptions jobmanager + poller receiver router sender utils - exceptions diff --git a/_sources/contributing.txt b/_sources/contributing.txt index 68088df..2489abb 100644 --- a/_sources/contributing.txt +++ b/_sources/contributing.txt @@ -2,6 +2,10 @@ Contributing to EventMQ ####################### +A few tips when working on the code + + * Use relative imports. If you use absolute imports then when you `import eventmq.exceptions` it's possible that you receive in return a different version of eventmq. exceptions installed somewhere else on the system. + .. toctree:: :maxdepth: 1 diff --git a/_sources/poller.txt b/_sources/poller.txt new file mode 100644 index 0000000..1aab472 --- /dev/null +++ b/_sources/poller.txt @@ -0,0 +1,3 @@ +.. automodule:: eventmq.poller + :members: + :special-members: diff --git a/_sources/protocol.txt b/_sources/protocol.txt index 64432dc..c32501c 100644 --- a/_sources/protocol.txt +++ b/_sources/protocol.txt @@ -46,6 +46,19 @@ From the 0MQ manual[[2](http://api.zeromq.org/master:zmq-socket)] This extra frame is not shown in the specifications below. +Global Frames +------------- +An **ACK** command consists of a 4-frame multipart message, formatted as follows. + +====== ============== =========== +FRAME Value Description +====== ============== =========== +0 _EMPTY_ leave empty +1 eMQP/1.0 Protocol version +2 ACK command +3 _MSGID_ A unique id for the msg +====== ============== =========== + eMQP / Client ------------- A **REQUEST** command consists of a 7-frame multipart message, formatted as follows. diff --git a/_sources/utils/classes.txt b/_sources/utils/classes.txt new file mode 100644 index 0000000..ab48e06 --- /dev/null +++ b/_sources/utils/classes.txt @@ -0,0 +1,3 @@ +.. automodule:: eventmq.utils.classes + :members: + :special-members: diff --git a/_sources/utils/messages.txt b/_sources/utils/messages.txt new file mode 100644 index 0000000..e49897c --- /dev/null +++ b/_sources/utils/messages.txt @@ -0,0 +1,3 @@ +.. automodule:: eventmq.utils.messages + :members: + :special-members: diff --git a/api.html b/api.html index 78c0f33..b51e9bc 100644 --- a/api.html +++ b/api.html @@ -31,7 +31,7 @@ - + @@ -83,12 +83,13 @@