From c972be300c5d182ad2a229cabb3150b365acad6b Mon Sep 17 00:00:00 2001 From: jason Date: Thu, 19 Nov 2015 17:42:59 -0700 Subject: documentation update --- _sources/api.txt | 3 +- _sources/exceptions.txt | 3 + _sources/utils.txt | 3 + api.html | 4 + exceptions.html | 240 ++++++++++++++++++++++++++++++++++++++++++++++++ genindex.html | 109 +++++++++++++++++++++- index.html | 2 + jobmanager.html | 52 +++++++++-- objects.inv | Bin 449 -> 589 bytes py-modindex.html | 10 ++ receiver.html | 21 +++-- router.html | 35 +++++-- searchindex.js | 2 +- sender.html | 53 +++++++++-- utils.html | 236 +++++++++++++++++++++++++++++++++++++++++++++++ 15 files changed, 735 insertions(+), 38 deletions(-) create mode 100644 _sources/exceptions.txt create mode 100644 _sources/utils.txt create mode 100644 exceptions.html create mode 100644 utils.html diff --git a/_sources/api.txt b/_sources/api.txt index 12ccbb2..b0ecf4e 100644 --- a/_sources/api.txt +++ b/_sources/api.txt @@ -9,4 +9,5 @@ API Documentation receiver router sender - + utils + exceptions diff --git a/_sources/exceptions.txt b/_sources/exceptions.txt new file mode 100644 index 0000000..17a1cf9 --- /dev/null +++ b/_sources/exceptions.txt @@ -0,0 +1,3 @@ +.. automodule:: eventmq.exceptions + :members: + :special-members: diff --git a/_sources/utils.txt b/_sources/utils.txt new file mode 100644 index 0000000..02904ed --- /dev/null +++ b/_sources/utils.txt @@ -0,0 +1,3 @@ +.. automodule:: eventmq.utils + :members: + :special-members: diff --git a/api.html b/api.html index e04493c..78c0f33 100644 --- a/api.html +++ b/api.html @@ -87,6 +87,8 @@
  • receiver – Receiver
  • router – Router
  • sender – Sender
    • +
  • utils – Utilities
    • +
  • exceptions – Exceptions
  • Contributing to EventMQ
    • @@ -142,6 +144,8 @@
  • receiver – Receiver
  • router – Router
  • sender – Sender
    • +
  • utils – Utilities
    • +
  • exceptions – Exceptions
    • diff --git a/exceptions.html b/exceptions.html new file mode 100644 index 0000000..cd2c165 --- /dev/null +++ b/exceptions.html @@ -0,0 +1,240 @@ + + + + + + + + + + + exceptions – Exceptions — EventMQ 0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + +
    + + + + + + +
    +
    + + + + + + +
    + +
    +
    +
    +
    + +
    +

    exceptions – Exceptions

    +

    These are the exceptions that are raised by EventMQ. All exceptions should +be subclasses of EventMQError

    +
    +
    +exception eventmq.exceptions.EventMQError
    +

    All exceptions raised by EventMQ inherit from this base exception

    +
    +
    +__weakref__
    +

    list of weak references to the object (if defined)

    +
    + +
    + +
    +
    +exception eventmq.exceptions.InvalidMessageError
    +

    Raise when EventMQ encounters a malformed message is encountered.

    +
    + +
    +
    +exception eventmq.exceptions.MessageError
    +

    Raised when there is a problem with the structure of the message

    +
    + +
    + + +
    +
    + + +
    +
    + +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html index 13c01a8..6e742cf 100644 --- a/genindex.html +++ b/genindex.html @@ -132,9 +132,14 @@ _ | C | E + | G + | I | J | L + | M | N + | O + | P | R | S | Z @@ -160,11 +165,15 @@
    -
    __weakref__ (eventmq.jobmanager.JobManager attribute) +
    __weakref__ (eventmq.exceptions.EventMQError attribute)
    +
    (eventmq.jobmanager.JobManager attribute) +
    + +
    (eventmq.receiver.Receiver attribute)
    @@ -200,6 +209,10 @@ - + +
    +
    eventmq.exceptions (module) +
    + +
    eventmq.jobmanager (module)
    @@ -207,16 +220,44 @@
    eventmq.receiver (module)
    -
    eventmq.router (module)
    +
    eventmq.sender (module)
    + +
    eventmq.utils (module) +
    + + +
    EventMQError +
    + +
    + +

    G

    + + +
    + +
    generate_msgid() (in module eventmq.utils) +
    + +
    + +

    I

    + +
    + +
    InvalidMessageError +
    +
    @@ -246,6 +287,16 @@
    +

    M

    + + +
    + +
    MessageError +
    + +
    +

    N

    @@ -262,6 +313,32 @@
    +

    O

    + + + +
    + +
    on_receive_reply() (eventmq.router.Router method) +
    + +
    + +
    on_receive_request() (eventmq.router.Router method) +
    + +
    + +

    P

    + + +
    + +
    parse_message() (in module eventmq.utils) +
    + +
    +

    R

    @@ -279,9 +356,17 @@
    Receiver (class in eventmq.receiver)
    + +
    recv() (eventmq.sender.Sender method) +
    +
    +
    recv_multipart() (eventmq.sender.Sender method) +
    + +
    Router (class in eventmq.router)
    @@ -296,19 +381,33 @@ -
    send_raw() (eventmq.sender.Sender method) +
    send_inform() (eventmq.jobmanager.JobManager method) +
    + + +
    send_message() (eventmq.jobmanager.JobManager method)
    +
    send_multipart() (eventmq.sender.Sender method) +
    + +
    Sender (class in eventmq.sender)
    -
    start() (eventmq.router.Router method) +
    start() (eventmq.jobmanager.JobManager method)
    +
    + +
    (eventmq.router.Router method) +
    + +
    diff --git a/index.html b/index.html index 2e2f22c..d91081e 100644 --- a/index.html +++ b/index.html @@ -136,6 +136,8 @@
  • receiver – Receiver
  • router – Router
  • sender – Sender
    • +
  • utils – Utilities
    • +
  • exceptions – Exceptions
  • Contributing to EventMQ
    • @@ -178,7 +214,7 @@ generated. Next - Previous + Previous diff --git a/objects.inv b/objects.inv index a13b23e..17ca09c 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/py-modindex.html b/py-modindex.html index f6bdf6c..3442ec3 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -144,6 +144,11 @@ eventmq + + +     + eventmq.exceptions +     @@ -164,6 +169,11 @@     eventmq.sender + + +     + eventmq.utils + diff --git a/receiver.html b/receiver.html index 2147864..038c890 100644 --- a/receiver.html +++ b/receiver.html @@ -31,6 +31,7 @@ + @@ -82,10 +83,14 @@ @@ -116,6 +121,8 @@