From dabe33f1a1d332649f42c9adfd9e5ec15501e64c Mon Sep 17 00:00:00 2001 From: Miguel Grinberg Date: Fri, 4 Mar 2016 07:42:35 -0800 Subject: [PATCH] document the need to monkey patch with eventlet and gevent --- docs/index.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 472d0ee..2eb3e5c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -276,7 +276,6 @@ through the ``RedisManager`` class. This class takes the same arguments as ``KombuManager``, but connects directly to a Redis store using the queue's pub/sub functionality:: - mgr = socketio.RedisManager('redis://') sio = socketio.Server(client_manager=mgr) @@ -294,6 +293,11 @@ of a listening thread. For example:: # emit an event redis.emit('my event', data={'foo': 'bar'}, room='my room') +Note: when using a third party package to manage a message queue such as Redis +or RabbitMQ in conjunction with eventlet or gevent, it is necessary to monkey +patch the Python standard library, so that these packages access coroutine +friendly library functions and classes. + Deployment ----------