sanic/docs/sanic
Ashley Sommer 30e6a310f1 Pausable response streams (#1179)
* This commit adds handlers for the asyncio/uvloop protocol callbacks for pause_writing and resume_writing.
These are needed for the correct functioning of built-in tcp flow-control provided by uvloop and asyncio.
This is somewhat of a breaking change, because the `write` function in user streaming callbacks now must be `await`ed.
This is necessary because it is possible now that the http protocol may be paused, and any calls to write may need to wait on an async event to be called to become unpaused.

Updated examples and tests to reflect this change.

This change does not apply to websocket connections. A change to websocket connections may be required to match this change.

* Fix a couple of PEP8 errors caused by previous rebase.

* update docs

add await syntax to response.write in response-streaming docs.

* remove commented out code from a test file
2018-08-18 18:12:13 -07:00
..
api_reference.rst improve doc and remove warnings 2017-07-02 10:02:04 -07:00
blueprints.md Add blueprint groups + nesting 2018-01-18 17:20:51 -08:00
class_based_views.md update description 2018-01-24 09:02:07 +08:00
config.md Add documentation for REQUEST_TIMEOUT, RESPONSE_TIMEOUT and KEEP_ALIVE_TIMEOUT config values. 2017-10-16 10:53:45 +10:00
contributing.md Add new contributing rules 2017-04-14 14:35:28 -05:00
cookies.rst Added a warning to the cookies documentation about security 2017-06-28 11:05:59 +09:00
custom_protocol.md Added basic readthedocs support 2017-01-29 12:47:00 -08:00
debug_mode.rst added init docs (#1167) 2018-04-01 20:53:08 -07:00
decorators.md add decorator docs 2017-03-23 15:16:46 -04:00
deploying.md Recycling gunicorn worker (#800) 2017-06-22 13:26:50 -07:00
exceptions.md exception.md code sample miss 'async' prefix 2018-02-26 16:09:26 +08:00
extensions.md Add sse extension (#1288) 2018-08-16 11:59:58 -07:00
getting_started.md Update getting_started.md 2017-09-18 11:37:32 +03:00
index.rst Fix formatting errors in RST files 2017-03-16 16:51:02 +11:00
logging.md add doc for customizing logging config 2017-09-13 18:30:38 -07:00
middleware.md Clarify arguments to request/response middleware 2018-03-21 12:07:26 +01:00
request_data.md Add request.method to documentation 2018-01-17 07:31:39 -08:00
response.md raw requires a bytes-like object 2018-02-15 00:11:37 +08:00
routing.md add an necessary import for better understanding 2018-02-26 11:24:54 +08:00
ssl.rst allow running with SSL via commandline 2017-03-07 19:57:10 -08:00
static_files.md use url_for for url building for static files 2017-09-06 19:17:52 +08:00
streaming.md Pausable response streams (#1179) 2018-08-18 18:12:13 -07:00
testing.md Typo 2017-12-11 14:33:43 +00:00
versioning.md Fix typo in documentation 2017-07-25 13:29:17 +03:00
websocket.rst fix doc 2018-02-09 21:32:09 -08:00