Skip to content

Commit 9f89bb6

Browse files
committed
Updated Readme to mention PubSub layer.
1 parent 4012ef7 commit 9f89bb6

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,16 @@ channels_redis
77
.. image:: https://img.shields.io/pypi/v/channels_redis.svg
88
:target: https://pypi.python.org/pypi/channels_redis
99

10-
A Django Channels channel layer that uses Redis as its backing store, and supports
11-
both a single-server and sharded configurations, as well as group support. Requires
12-
Python 3.6 or higher to function correctly (3.5 will look like it works, but have
13-
random errors).
10+
Provides Django Channels channel layers that use Redis as a backing store.
11+
12+
There are two available implementations:
13+
14+
* ``RedisChannelLayer`` is the orignal layer, and implements channel and group
15+
handling itself.
16+
* ``RedisPubSubChannelLayer`` is newer and leverages Redis Pub/Sub for message
17+
dispatch.
18+
19+
Both layers support a single-server and sharded configurations.
1420

1521
**Note:** Prior versions of this package were called ``asgi_redis`` and are
1622
still available under PyPI as that name if you need them for Channels 1.x projects.
@@ -165,7 +171,7 @@ If you're using Django, you may also wish to set this to your site's
165171
}
166172
167173
``on_disconnect`` / ``on_reconnect``
168-
~~~~~~~~~~~~
174+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
169175

170176
The PubSub layer, which maintains long-running connections to Redis, can drop messages in the event of a network partition.
171177
To handle such situations the PubSub layer accepts optional arguments which will notify consumers of Redis disconnect/reconnect events.
@@ -194,8 +200,8 @@ And then in your channels consumer, you can implement the handler:
194200
Dependencies
195201
------------
196202

197-
Redis >= 5.0 is required for `channels_redis`. It supports Python 3.5.2 and up
198-
(3.5.0 or 3.5.1 will not work due to our dependency, ``aioredis``).
203+
Redis >= 5.0 is required for `channels_redis`. Python 3.6 or higher is required.
204+
199205

200206
Contributing
201207
------------

0 commit comments

Comments
 (0)