diff options
author | Victor Stinner <victor.stinner@gmail.com> | 2013-12-03 18:17:25 (GMT) |
---|---|---|
committer | Victor Stinner <victor.stinner@gmail.com> | 2013-12-03 18:17:25 (GMT) |
commit | 99c2ab4b837288c0b29a1777988b07a77171c544 (patch) | |
tree | db1360486bdf22f174f60c472f2c4d5dc74c111b /Doc/library/asyncio-protocol.rst | |
parent | cf6f72e329838d774dbd9cbb795c7d213ebc55bc (diff) | |
download | cpython-99c2ab4b837288c0b29a1777988b07a77171c544.zip cpython-99c2ab4b837288c0b29a1777988b07a77171c544.tar.gz cpython-99c2ab4b837288c0b29a1777988b07a77171c544.tar.bz2 |
asyncio doc: oh, asyncio module has its own Future class
Improve also wait() documentation: mention that the first parameter is a
sequence
Diffstat (limited to 'Doc/library/asyncio-protocol.rst')
-rw-r--r-- | Doc/library/asyncio-protocol.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index 6794fdf..4b56b57 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -235,8 +235,9 @@ StreamWriter Wraps a Transport. - This exposes :meth:`write`, :meth:`writelines`, :meth:`can_write_eof()`, :meth:`write_eof`, :meth:`get_extra_info` and - :meth:`close`. It adds :meth:`drain` which returns an optional :class:`~concurrent.futures.Future` on which you can + This exposes :meth:`write`, :meth:`writelines`, :meth:`can_write_eof()`, + :meth:`write_eof`, :meth:`get_extra_info` and :meth:`close`. It adds + :meth:`drain` which returns an optional :class:`Future` on which you can wait for flow control. It also adds a transport attribute which references the :class:`Transport` directly. @@ -260,7 +261,7 @@ StreamWriter When there's nothing to wait for, :meth:`drain()` returns ``()``, and the yield-from continues immediately. When the transport buffer is full (the protocol is paused), :meth:`drain` creates and returns a - :class:`~concurrent.futures.Future` and the yield-from will block until + :class:`Future` and the yield-from will block until that Future is completed, which will happen when the buffer is (partially) drained and the protocol is resumed. |