mirror of https://github.com/zeromq/pyzmq.git
95 lines
1.8 KiB
ReStructuredText
95 lines
1.8 KiB
ReStructuredText
.. AUTO-GENERATED FILE -- DO NOT EDIT!
|
|
|
|
asyncio
|
|
=======
|
|
|
|
Module: :mod:`zmq.asyncio`
|
|
--------------------------
|
|
.. automodule:: zmq.asyncio
|
|
|
|
.. currentmodule:: zmq.asyncio
|
|
|
|
.. versionadded:: 15.0
|
|
|
|
As of 15.0, pyzmq now supports :mod:`asyncio`, via :mod:`zmq.asyncio`.
|
|
When imported from this module, blocking methods such as
|
|
:meth:`zmq.asyncio.Socket.recv_multipart`, :meth:`zmq.asyncio.Socket.poll`,
|
|
and :meth:`zmq.asyncio.Poller.poll` return :class:`~.asyncio.Future` s.
|
|
|
|
.. sourcecode:: python
|
|
|
|
import asyncio
|
|
import zmq
|
|
import zmq.asyncio
|
|
|
|
ctx = zmq.asyncio.Context()
|
|
|
|
async def recv_and_process():
|
|
sock = ctx.socket(zmq.PULL)
|
|
sock.bind(url)
|
|
msg = await sock.recv_multipart() # waits for msg to be ready
|
|
reply = await async_process(msg)
|
|
await sock.send_multipart(reply)
|
|
|
|
asyncio.run(recv_and_process())
|
|
|
|
|
|
Classes
|
|
-------
|
|
|
|
:class:`ZMQEventLoop`
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: ZMQEventLoop
|
|
|
|
|
|
:class:`Context`
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
Context class that creates Future-returning sockets. See :class:`zmq.Context` for more info.
|
|
|
|
.. autoclass:: Context
|
|
:noindex:
|
|
|
|
|
|
|
|
:class:`Socket`
|
|
~~~~~~~~~~~~~~~
|
|
|
|
Socket subclass that returns :class:`asyncio.Future` s from blocking methods,
|
|
for use in coroutines and async applications.
|
|
|
|
.. seealso::
|
|
|
|
:class:`zmq.Socket` for the inherited API.
|
|
|
|
.. autoclass:: Socket
|
|
:noindex:
|
|
|
|
.. automethod:: recv
|
|
:noindex:
|
|
.. automethod:: recv_multipart
|
|
:noindex:
|
|
.. automethod:: send
|
|
:noindex:
|
|
.. automethod:: send_multipart
|
|
:noindex:
|
|
.. automethod:: poll
|
|
:noindex:
|
|
|
|
:class:`Poller`
|
|
~~~~~~~~~~~~~~~
|
|
|
|
Poller subclass that returns :class:`asyncio.Future` s from poll,
|
|
for use in coroutines and async applications.
|
|
|
|
.. seealso::
|
|
|
|
:class:`zmq.Poller` for the inherited API.
|
|
|
|
.. autoclass:: Poller
|
|
:noindex:
|
|
|
|
.. automethod:: poll
|
|
:noindex:
|