diff options
Diffstat (limited to '_sources')
| -rw-r--r-- | _sources/api.txt | 3 | ||||
| -rw-r--r-- | _sources/contributing.txt | 4 | ||||
| -rw-r--r-- | _sources/poller.txt | 3 | ||||
| -rw-r--r-- | _sources/protocol.txt | 13 | ||||
| -rw-r--r-- | _sources/utils/classes.txt | 3 | ||||
| -rw-r--r-- | _sources/utils/messages.txt | 3 |
6 files changed, 28 insertions, 1 deletions
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 | |||
| 5 | .. toctree:: | 5 | .. toctree:: |
| 6 | :maxdepth: 2 | 6 | :maxdepth: 2 |
| 7 | 7 | ||
| 8 | exceptions | ||
| 8 | jobmanager | 9 | jobmanager |
| 10 | poller | ||
| 9 | receiver | 11 | receiver |
| 10 | router | 12 | router |
| 11 | sender | 13 | sender |
| 12 | utils | 14 | utils |
| 13 | 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 @@ | |||
| 2 | Contributing to EventMQ | 2 | Contributing to EventMQ |
| 3 | ####################### | 3 | ####################### |
| 4 | 4 | ||
| 5 | A few tips when working on the code | ||
| 6 | |||
| 7 | * 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. | ||
| 8 | |||
| 5 | .. toctree:: | 9 | .. toctree:: |
| 6 | :maxdepth: 1 | 10 | :maxdepth: 1 |
| 7 | 11 | ||
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 @@ | |||
| 1 | .. automodule:: eventmq.poller | ||
| 2 | :members: | ||
| 3 | :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)] | |||
| 46 | 46 | ||
| 47 | This extra frame is not shown in the specifications below. | 47 | This extra frame is not shown in the specifications below. |
| 48 | 48 | ||
| 49 | Global Frames | ||
| 50 | ------------- | ||
| 51 | An **ACK** command consists of a 4-frame multipart message, formatted as follows. | ||
| 52 | |||
| 53 | ====== ============== =========== | ||
| 54 | FRAME Value Description | ||
| 55 | ====== ============== =========== | ||
| 56 | 0 _EMPTY_ leave empty | ||
| 57 | 1 eMQP/1.0 Protocol version | ||
| 58 | 2 ACK command | ||
| 59 | 3 _MSGID_ A unique id for the msg | ||
| 60 | ====== ============== =========== | ||
| 61 | |||
| 49 | eMQP / Client | 62 | eMQP / Client |
| 50 | ------------- | 63 | ------------- |
| 51 | A **REQUEST** command consists of a 7-frame multipart message, formatted as follows. | 64 | 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 @@ | |||
| 1 | .. automodule:: eventmq.utils.classes | ||
| 2 | :members: | ||
| 3 | :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 @@ | |||
| 1 | .. automodule:: eventmq.utils.messages | ||
| 2 | :members: | ||
| 3 | :special-members: | ||