From e18bfed8f30e840c0c6c2874d5a0f5925b25b011 Mon Sep 17 00:00:00 2001 From: Andrew Godwin Date: Mon, 4 Apr 2016 00:34:55 +0200 Subject: [PATCH] Clarify timeout behaviour of block() in asgi --- docs/asgi.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/asgi.rst b/docs/asgi.rst index d023f28..18ebcfd 100644 --- a/docs/asgi.rst +++ b/docs/asgi.rst @@ -274,7 +274,9 @@ A *channel layer* must provide an object with these attributes or ``(channel, message)`` if a message is available. If ``block`` is True, then it will not return until after a built-in timeout or a message arrives; if ``block`` is false, it will always return immediately. It is perfectly - valid to ignore ``block`` and always return immediately. + valid to ignore ``block`` and always return immediately. If ``block`` is True, + there must be a finite timeout before this returns ``(None, None)`` and that + timeout must be less than sixty seconds (preferably around five). * ``new_channel(pattern)``, a callable that takes a unicode string pattern, and returns a new valid channel name that does not already exist, by