Skip to content

Commit 8159396

Browse files
author
zeekay
committed
Update README.
1 parent cf18e9d commit 8159396

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ automatically for you.
7373
API
7474
---
7575
Flask-uWSGI-Websocket automatically performs the WebSocket handshake for you
76-
and passes your router a websocket client exposing `uWSGI's WebSocket API
76+
and passes your route handler a websocket client exposing `uWSGI's WebSocket API
7777
<http://uwsgi-docs.readthedocs.org/en/latest/WebSockets.html#api>`_.
7878

7979
``websocket.recv()``
@@ -88,5 +88,9 @@ and passes your router a websocket client exposing `uWSGI's WebSocket API
8888

8989
``websocket.send_binary_from_sharedarea(id, pos)``
9090

91-
In addition there is a special ``websocket.receive()`` method which makes using
92-
non-blocking calls simpler.
91+
In addition there is a special ``websocket.receive()`` method which tries to
92+
make non-blocking calls simpler. When using the ``WebSocket`` plugin, it blocks
93+
making it appropriate for threaded or multiprocess concurrency models. When
94+
using ``GeventWebSocket`` it'll take advantage of gevent and make a
95+
non-blocking recv call. ``AsyncWebsocket`` should do roughly the same thing,
96+
but currently plain ``--async`` concurrency model is a bit buggy with uWSGI 2.0.

0 commit comments

Comments
 (0)