Skip to content
Snippets Groups Projects
Commit 106af1a8 authored by Piotr Maślanka's avatar Piotr Maślanka
Browse files

docs fix

parent 0a5a76ec
No related branches found
No related tags found
No related merge requests found
Pipeline #63903 passed with stages
in 2 minutes and 35 seconds
Usage basics
============
First off, you need a Cluster object:
.. autoclass:: coolamqp.clustering.Cluster
:members:
You will need to initialize it with NodeDefinitions:
.. autoclass:: coolamqp.objects.NodeDefinition
You can send messages:
.. autoclass:: coolamqp.objects.Message
and receive them
.. autoclass:: coolamqp.objects.ReceivedMessage
:members:
MessageProperties
-----------------
.. autoclass:: coolamqp.objects.MessageProperties
:members:
.. autoclass:: coolamqp.framing.definitions.BasicContentPropertyList
:members:
:undoc-members:
Take care, as :class:`~coolamqp.objects.MessageProperties` will hash the
keys found and store it within non-GCable memory. So each "variant" of message
properties encountered will be compiled as a separate class.
Who am I talking to?
--------------------
:class:`coolamqp.clustering.Cluster` has a nice property, that will return None until the connection is established.
If it is, it will return something like this:
.. autoclass:: coolamqp.objects.ServerProperties
:members:
......@@ -10,10 +10,10 @@ Welcome to CoolAMQP's documentation!
tutorials
how-to-guide
caveats
frames
basics
tracing
advanced
reference
frames
Quick FAQ
=========
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment