Browse Source

documentation updates

pull/9/head
Miguel Grinberg 10 years ago
parent
commit
e56ff807f4
  1. 2
      README.rst
  2. 15
      docs/index.rst

2
README.rst

@ -27,6 +27,8 @@ Features
assigned to "rooms". assigned to "rooms".
- Optional support for multiple servers, connected through a messaging queue - Optional support for multiple servers, connected through a messaging queue
such as Redis or RabbitMQ. such as Redis or RabbitMQ.
- Send messages to clients from external processes, such as Celery workers or
auxiliary scripts.
- Event-based architecture implemented with decorators that hides the details - Event-based architecture implemented with decorators that hides the details
of the protocol. of the protocol.
- Support for HTTP long-polling and WebSocket transports. - Support for HTTP long-polling and WebSocket transports.

15
docs/index.rst

@ -30,6 +30,8 @@ features:
assigned to "rooms". assigned to "rooms".
- Optional support for multiple servers, connected through a messaging queue - Optional support for multiple servers, connected through a messaging queue
such as Redis or RabbitMQ. such as Redis or RabbitMQ.
- Send messages to clients from external processes, such as Celery workers or
auxiliary scripts.
- Event-based architecture implemented with decorators that hides the details - Event-based architecture implemented with decorators that hides the details
of the protocol. of the protocol.
- Support for HTTP long-polling and WebSocket transports. - Support for HTTP long-polling and WebSocket transports.
@ -212,13 +214,14 @@ Using a Message Queue
--------------------- ---------------------
The Socket.IO server owns the socket connections to all the clients, so it is The Socket.IO server owns the socket connections to all the clients, so it is
the only process that can emit events to them. A common need of larger the only process that can emit events to them. Unfortunately this becomes a
applications is to emit events to clients from a different process, like a limitation for many applications, as a common need is to emit events to
a `Celery <http://www.celeryproject.org/>`_ worker, or any other auxiliary clients from a different process, like a
process that works in conjunction with the server. `Celery <http://www.celeryproject.org/>`_ worker, or any other auxiliary
process or script that works in conjunction with the server.
To enable these other processes to emit events, the server can be configured To enable these other processes to emit events, the server can be configured
to listen for events to emit to clients on a message queue such as to listen for externally issued events on a message queue such as
`Redis <http://redis.io/>`_ or `RabbitMQ <https://www.rabbitmq.com/>`_. `Redis <http://redis.io/>`_ or `RabbitMQ <https://www.rabbitmq.com/>`_.
Processes that need to emit events to client then post these events to the Processes that need to emit events to client then post these events to the
queue. queue.
@ -232,7 +235,7 @@ ta message queue.
The message queue service needs to be installed and configured separately. By The message queue service needs to be installed and configured separately. By
default, the server uses `Kombu <http://kombu.readthedocs.org/en/latest/>`_ default, the server uses `Kombu <http://kombu.readthedocs.org/en/latest/>`_
to read and write to the queue, so any message queue supported by this package to access the message queue, so any message queue supported by this package
can be used. Kombu can be installed with pip:: can be used. Kombu can be installed with pip::
pip install kombu pip install kombu

Loading…
Cancel
Save