summaryrefslogtreecommitdiff
path: root/docs/source/api
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/api')
-rw-r--r--docs/source/api/index.rst26
-rw-r--r--docs/source/api/zmq.auth.ioloop.rst20
-rw-r--r--docs/source/api/zmq.auth.rst30
-rw-r--r--docs/source/api/zmq.auth.thread.rst24
-rw-r--r--docs/source/api/zmq.devices.rst86
-rw-r--r--docs/source/api/zmq.green.rst7
-rw-r--r--docs/source/api/zmq.rst142
-rw-r--r--docs/source/api/zmq.utils.win32.rst19
8 files changed, 354 insertions, 0 deletions
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
new file mode 100644
index 0000000..87ef242
--- /dev/null
+++ b/docs/source/api/index.rst
@@ -0,0 +1,26 @@
+.. _api-index:
+
+###################
+ The PyZMQ API
+###################
+
+:Release: |release|
+:Date: |today|
+
+.. toctree::
+
+ zmq
+ zmq.devices
+ zmq.green
+ generated/zmq.eventloop.ioloop
+ generated/zmq.eventloop.zmqstream
+ zmq.auth
+ zmq.auth.thread
+ zmq.auth.ioloop
+ generated/zmq.log.handlers
+ generated/zmq.ssh.tunnel
+ generated/zmq.utils.jsonapi
+ generated/zmq.utils.monitor
+ generated/zmq.utils.z85
+ zmq.utils.win32
+
diff --git a/docs/source/api/zmq.auth.ioloop.rst b/docs/source/api/zmq.auth.ioloop.rst
new file mode 100644
index 0000000..efcb026
--- /dev/null
+++ b/docs/source/api/zmq.auth.ioloop.rst
@@ -0,0 +1,20 @@
+.. AUTO-GENERATED FILE -- DO NOT EDIT!
+
+auth.ioloop
+===========
+
+Module: :mod:`auth.ioloop`
+--------------------------
+.. automodule:: zmq.auth.ioloop
+
+.. currentmodule:: zmq.auth.ioloop
+
+:class:`IOLoopAuthenticator`
+----------------------------
+
+
+.. autoclass:: IOLoopAuthenticator
+ :members:
+ :undoc-members:
+ :inherited-members:
+
diff --git a/docs/source/api/zmq.auth.rst b/docs/source/api/zmq.auth.rst
new file mode 100644
index 0000000..6ca29d7
--- /dev/null
+++ b/docs/source/api/zmq.auth.rst
@@ -0,0 +1,30 @@
+auth
+====
+
+Module: :mod:`auth`
+-------------------
+.. automodule:: zmq.auth
+
+.. currentmodule:: zmq.auth
+
+
+:class:`Authenticator`
+----------------------
+
+
+.. autoclass:: Authenticator
+ :members:
+ :undoc-members:
+ :inherited-members:
+
+
+Functions
+---------
+
+
+.. autofunction:: create_certificates
+
+.. autofunction:: load_certificate
+
+.. autofunction:: load_certificates
+
diff --git a/docs/source/api/zmq.auth.thread.rst b/docs/source/api/zmq.auth.thread.rst
new file mode 100644
index 0000000..e2c0b1b
--- /dev/null
+++ b/docs/source/api/zmq.auth.thread.rst
@@ -0,0 +1,24 @@
+.. AUTO-GENERATED FILE -- DO NOT EDIT!
+
+auth.thread
+===========
+
+Module: :mod:`auth.thread`
+--------------------------
+.. automodule:: zmq.auth.thread
+
+.. currentmodule:: zmq.auth.thread
+
+Classes
+-------
+
+
+:class:`ThreadAuthenticator`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+.. autoclass:: ThreadAuthenticator
+ :members:
+ :undoc-members:
+ :inherited-members:
+
diff --git a/docs/source/api/zmq.devices.rst b/docs/source/api/zmq.devices.rst
new file mode 100644
index 0000000..690b0b5
--- /dev/null
+++ b/docs/source/api/zmq.devices.rst
@@ -0,0 +1,86 @@
+devices
+=======
+
+Functions
+---------
+
+.. autofunction:: zmq.device
+
+.. autofunction:: zmq.proxy
+
+Module: :mod:`zmq.devices`
+--------------------------
+.. automodule:: zmq.devices
+
+.. currentmodule:: zmq.devices
+
+
+Base Devices
+------------
+
+:class:`Device`
+***************
+
+.. autoclass:: Device
+ :members:
+ :exclude-members: context_factory, run, run_device
+
+:class:`ThreadDevice`
+*********************
+
+.. autoclass:: ThreadDevice
+ :members:
+
+:class:`ProcessDevice`
+**********************
+
+.. autoclass:: ProcessDevice
+ :members:
+
+
+Proxy Devices
+-------------
+
+:class:`Proxy`
+********************
+
+.. autoclass:: Proxy
+ :members: bind_mon, connect_mon, setsockopt_mon
+
+:class:`ThreadProxy`
+********************
+
+.. autoclass:: ThreadProxy
+ :members:
+
+:class:`ProcessProxy`
+*********************
+
+.. autoclass:: ProcessProxy
+ :members:
+
+
+MonitoredQueue Devices
+----------------------
+
+.. autofunction:: zmq.devices.monitored_queue
+
+:class:`MonitoredQueue`
+*****************************
+
+.. autoclass:: MonitoredQueue
+ :members:
+
+:class:`ThreadMonitoredQueue`
+*****************************
+
+.. autoclass:: ThreadMonitoredQueue
+ :members:
+
+:class:`ProcessMonitoredQueue`
+******************************
+
+.. autoclass:: ProcessMonitoredQueue
+ :members:
+
+
diff --git a/docs/source/api/zmq.green.rst b/docs/source/api/zmq.green.rst
new file mode 100644
index 0000000..6d0667a
--- /dev/null
+++ b/docs/source/api/zmq.green.rst
@@ -0,0 +1,7 @@
+green
+=====
+
+Module: :mod:`green`
+--------------------
+
+.. automodule:: zmq.green
diff --git a/docs/source/api/zmq.rst b/docs/source/api/zmq.rst
new file mode 100644
index 0000000..c7c2fb2
--- /dev/null
+++ b/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
diff --git a/docs/source/api/zmq.utils.win32.rst b/docs/source/api/zmq.utils.win32.rst
new file mode 100644
index 0000000..921701a
--- /dev/null
+++ b/docs/source/api/zmq.utils.win32.rst
@@ -0,0 +1,19 @@
+utils.win32
+===========
+
+
+Module: :mod:`zmq.utils.win32`
+------------------------------
+
+.. automodule:: zmq.utils.win32
+
+.. currentmodule:: zmq.utils.win32
+
+
+:class:`allow_interrupt`
+------------------------
+
+
+.. autoclass:: allow_interrupt
+
+