django/daphne
1
1
Fork 0
mirror of https://github.com/django/daphne.git synced 2025-07-10 16:02:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

Clarify timeout behaviour of block() in asgi

Browse Source
This commit is contained in:
Andrew Godwin 2016-04-04 00:34:55 +02:00
parent a563d4353f
commit e18bfed8f3
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/asgi.rst
View File

@ -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 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 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 ``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, * ``new_channel(pattern)``, a callable that takes a unicode string pattern,
and returns a new valid channel name that does not already exist, by and returns a new valid channel name that does not already exist, by