summaryrefslogtreecommitdiffstats
path: root/external_libs/python/pyzmq-14.7.0/docs/source/api/zmq.rst
diff options
context:
space:
mode:
Diffstat (limited to 'external_libs/python/pyzmq-14.7.0/docs/source/api/zmq.rst')
-rw-r--r--external_libs/python/pyzmq-14.7.0/docs/source/api/zmq.rst142
1 files changed, 142 insertions, 0 deletions
diff --git a/external_libs/python/pyzmq-14.7.0/docs/source/api/zmq.rst b/external_libs/python/pyzmq-14.7.0/docs/source/api/zmq.rst
new file mode 100644
index 00000000..c7c2fb21
--- /dev/null
+++ b/external_libs/python/pyzmq-14.7.0/docs/source/api/zmq.rst
@@ -0,0 +1,142 @@
+zmq
+===
+
+.. automodule:: zmq
+
+.. currentmodule:: zmq
+
+Basic Classes
+-------------
+
+:class:`Context`
+****************
+
+
+.. autoclass:: Context
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :exclude-members: sockopts, closed
+
+ .. attribute:: closed
+
+ boolean - whether the context has been terminated.
+ If True, you can no longer use this Context.
+
+
+:class:`Socket`
+***************
+
+
+.. autoclass:: Socket
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :exclude-members: closed, context, getsockopt_unicode, recv_unicode, setsockopt_unicode, send_unicode
+
+ .. attribute:: closed
+
+ boolean - whether the socket has been closed.
+ If True, you can no longer use this Socket.
+
+
+
+:class:`Frame`
+**************
+
+
+.. autoclass:: Frame
+ :members:
+ :inherited-members:
+
+
+:class:`MessageTracker`
+***********************
+
+
+.. autoclass:: MessageTracker
+ :members:
+ :inherited-members:
+
+
+Polling
+-------
+
+:class:`Poller`
+***************
+
+.. autoclass:: Poller
+ :members:
+ :inherited-members:
+
+
+.. autofunction:: zmq.select
+
+
+Exceptions
+----------
+
+:class:`ZMQError`
+*****************
+
+.. autoclass:: ZMQError
+ :members:
+ :inherited-members:
+
+
+:class:`ZMQVersionError`
+*****************
+
+.. autoclass:: ZMQVersionError
+ :members:
+ :inherited-members:
+
+:class:`Again`
+**************
+
+
+.. autoclass:: Again
+
+
+:class:`ContextTerminated`
+**************************
+
+
+.. autoclass:: ContextTerminated
+
+
+:class:`NotDone`
+****************
+
+
+.. autoclass:: NotDone
+
+
+:class:`ZMQBindError`
+*********************
+
+
+.. autoclass:: ZMQBindError
+
+
+
+Functions
+---------
+
+.. autofunction:: zmq.zmq_version
+
+.. autofunction:: zmq.pyzmq_version
+
+.. autofunction:: zmq.zmq_version_info
+
+.. autofunction:: zmq.pyzmq_version_info
+
+.. autofunction:: zmq.has
+
+.. autofunction:: zmq.device
+
+.. autofunction:: zmq.proxy
+
+.. autofunction:: zmq.curve_keypair
+
+.. autofunction:: zmq.get_includes \ No newline at end of file