diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/request-response.txt | 30 | ||||
| -rw-r--r-- | docs/topics/async.txt | 3 |
2 files changed, 33 insertions, 0 deletions
diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt index e70dae4de7..ee98b4b8b1 100644 --- a/docs/ref/request-response.txt +++ b/docs/ref/request-response.txt @@ -1282,6 +1282,36 @@ Attributes This is useful for middleware needing to wrap :attr:`StreamingHttpResponse.streaming_content`. +.. _request-response-streaming-disconnect: + +Handling disconnects +-------------------- + +.. versionadded:: 5.0 + +If the client disconnects during a streaming response, Django will cancel the +coroutine that is handling the response. If you want to clean up resources +manually, you can do so by catching the ``asyncio.CancelledError``:: + + async def streaming_response(): + try: + # Do some work here + async for chunk in my_streaming_iterator(): + yield chunk + except asyncio.CancelledError: + # Handle disconnect + ... + raise + + + async def my_streaming_view(request): + return StreamingHttpResponse(streaming_response()) + +This example only shows how to handle client disconnection while the response +is streaming. If you perform long-running operations in your view before +returning the ``StreamingHttpResponse`` object, then you may also want to +:ref:`handle disconnections in the view <async-handling-disconnect>` itself. + ``FileResponse`` objects ======================== diff --git a/docs/topics/async.txt b/docs/topics/async.txt index b16ffe0f78..1faf787380 100644 --- a/docs/topics/async.txt +++ b/docs/topics/async.txt @@ -197,6 +197,9 @@ cleanup:: # Handle disconnect raise +You can also :ref:`handle client disconnects in streaming responses +<request-response-streaming-disconnect>`. + .. _async-safety: Async safety |