Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
e7182979
Commit
e7182979
authored
Nov 28, 2014
by
Victor Stinner
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Closes #22348: Rephrase asyncio.StreamWriter.drain() documentation
Patch written by Martin Richard.
parent
1deee54e
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
11 additions
and
4 deletions
+11
-4
Doc/library/asyncio-stream.rst
Doc/library/asyncio-stream.rst
+10
-4
Misc/ACKS
Misc/ACKS
+1
-0
No files found.
Doc/library/asyncio-stream.rst
View file @
e7182979
...
...
@@ -170,16 +170,22 @@ StreamWriter
.. method:: drain()
Wait until the write buffer of the underlying transport is
flushed.
Let the write buffer of the underlying transport a chance to be
flushed.
The intended use is to write::
w.write(data)
yield from w.drain()
When the transport buffer is full (the protocol is paused), block until
the buffer is (partially) drained and the protocol is resumed. When there
is nothing to wait for, the yield-from continues immediately.
When the size of the transport buffer reaches the high-water limit (the
protocol is paused), block until the size of the buffer is drained down
to the low-water limit and the protocol is resumed. When there is nothing
to wait for, the yield-from continues immediately.
Yielding from :meth:`drain` gives the opportunity for the loop to
schedule the write operation and flush the buffer. It should especially
be used when a possibly large amount of data is written to the transport,
and the coroutine does not yield-from between calls to :meth:`write`.
This method is a :ref:`coroutine <coroutine>`.
...
...
Misc/ACKS
View file @
e7182979
...
...
@@ -1125,6 +1125,7 @@ Francesco Ricciardi
Tim Rice
Jan Pieter Riegel
Armin Rigo
Martin Richard
Arc Riley
Nicholas Riley
Jean-Claude Rimbault
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment