Skip to content

Commit e56ff80

Browse files
documentation updates
1 parent 6ae8968 commit e56ff80

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ Features
2727
assigned to "rooms".
2828
- Optional support for multiple servers, connected through a messaging queue
2929
such as Redis or RabbitMQ.
30+
- Send messages to clients from external processes, such as Celery workers or
31+
auxiliary scripts.
3032
- Event-based architecture implemented with decorators that hides the details
3133
of the protocol.
3234
- Support for HTTP long-polling and WebSocket transports.

docs/index.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ features:
3030
assigned to "rooms".
3131
- Optional support for multiple servers, connected through a messaging queue
3232
such as Redis or RabbitMQ.
33+
- Send messages to clients from external processes, such as Celery workers or
34+
auxiliary scripts.
3335
- Event-based architecture implemented with decorators that hides the details
3436
of the protocol.
3537
- Support for HTTP long-polling and WebSocket transports.
@@ -212,13 +214,14 @@ Using a Message Queue
212214
---------------------
213215

214216
The Socket.IO server owns the socket connections to all the clients, so it is
215-
the only process that can emit events to them. A common need of larger
216-
applications is to emit events to clients from a different process, like a
217-
a `Celery <http://www.celeryproject.org/>`_ worker, or any other auxiliary
218-
process that works in conjunction with the server.
217+
the only process that can emit events to them. Unfortunately this becomes a
218+
limitation for many applications, as a common need is to emit events to
219+
clients from a different process, like a
220+
`Celery <http://www.celeryproject.org/>`_ worker, or any other auxiliary
221+
process or script that works in conjunction with the server.
219222

220223
To enable these other processes to emit events, the server can be configured
221-
to listen for events to emit to clients on a message queue such as
224+
to listen for externally issued events on a message queue such as
222225
`Redis <http://redis.io/>`_ or `RabbitMQ <https://www.rabbitmq.com/>`_.
223226
Processes that need to emit events to client then post these events to the
224227
queue.
@@ -232,7 +235,7 @@ ta message queue.
232235

233236
The message queue service needs to be installed and configured separately. By
234237
default, the server uses `Kombu <http://kombu.readthedocs.org/en/latest/>`_
235-
to read and write to the queue, so any message queue supported by this package
238+
to access the message queue, so any message queue supported by this package
236239
can be used. Kombu can be installed with pip::
237240

238241
pip install kombu

0 commit comments

Comments
 (0)