walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2015-04-01 23:10:01 +09:00
parent b0123448a4
commit 28cfae162a
1 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/sources/python-apiref.rst
View File

@ -259,15 +259,16 @@ HTTP/2 servers
size. The body generator generates response body. It can pause size. The body generator generates response body. It can pause
generation of response so that it can wait for slow backend data generation of response so that it can wait for slow backend data
generation. When invoked, it should return tuple, byte string generation. When invoked, it should return tuple, byte string
at most size length and flag. The flag is either ``DATA_OK``, at most size length and flag. The flag is either
``DATA_EOF`` or ``DATA_DEFERRED``. For non-empty byte string :py:data:`DATA_OK`, :py:data:`DATA_EOF` or
and it is not the last chunk of response, ``DATA_OK`` must be :py:data:`DATA_DEFERRED`. For non-empty byte string and it is
not the last chunk of response, :py:data:`DATA_OK` must be
returned as flag. If this is the last chunk of the response returned as flag. If this is the last chunk of the response
(byte string could be ``None``), ``DATA_EOF`` must be returned (byte string could be ``None``), :py:data:`DATA_EOF` must be
as flag. If there is no data available right now, but returned as flag. If there is no data available right now, but
additional data are anticipated, return tuple (``None``, additional data are anticipated, return tuple (``None``,
``DATA_DEFERRD``). When data arrived, call :py:meth:`resume()` :py:data:`DATA_DEFERRD`). When data arrived, call
and restart response body transmission. :py:meth:`resume()` and restart response body transmission.
Only the body generator can pause response body generation; Only the body generator can pause response body generation;
instance of :py:class:`io.IOBase` must not block. instance of :py:class:`io.IOBase` must not block.
@ -315,6 +316,19 @@ HTTP/2 servers
an error calling this method while response body transmission is an error calling this method while response body transmission is
not paused. not paused.
.. py:data:: DATA_OK
``DATA_OK`` indicates non empty data is generated from body generator.
.. py:data:: DATA_EOF
``DATA_EOF`` indicates the end of response body.
.. py:data:: DATA_DEFERRED
``DATA_DEFERRED`` indicates that data are not available right now
and response should be paused.
The following example illustrates :py:class:`HTTP2Server` and The following example illustrates :py:class:`HTTP2Server` and
:py:class:`BaseRequestHandler` usage: :py:class:`BaseRequestHandler` usage: