django/daphne
1
1
Fork 0
mirror of https://github.com/django/daphne.git synced 2025-08-04 10:30:08 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improve "Persisting Data" example code (#683)

Browse Source 
* Improve "Persisting Data" example code

Relates to issue #662.
Please review this commit too. I believe I covered everything appropriately, but any suggestions are welcome.

* Remove extra whitespace

Fixed a small typo in the Getting Started | persisting data section
Improves upon issue #662
This commit is contained in:
Sergio 2017-06-24 20:14:06 -04:00 committed by Andrew Godwin
parent e6c06861c4
commit 26916cccc7
1 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/getting-started.rst
View File

@ -382,26 +382,35 @@ provides you with an attribute called ``message.channel_session`` that acts
just like a normal Django session. just like a normal Django session.
Let's use it now to build a chat server that expects you to pass a chatroom Let's use it now to build a chat server that expects you to pass a chatroom
name in the path of your WebSocket request (we'll ignore auth for now - that's next):: name in the path of your WebSocket request and a query string with your username (we'll ignore auth for now - that's next)::
# In consumers.py # In consumers.py
from channels import Group from channels import Group
from channels.sessions import channel_session from channels.sessions import channel_session
from urllib.parse import parse_qs
# Connected to websocket.connect # Connected to websocket.connect
@channel_session @channel_session
def ws_connect(message, room_name): def ws_connect(message, room_name):
# Accept connection # Accept connection
message.reply_channel.send({"accept": True}) message.reply_channel.send({"accept": True})
# Save room in session and add us to the group # Parse the query string
message.channel_session['room_name'] = room_name params = parse_qs(message.content["query_string"])
Group("chat-%s" % room).add(message.reply_channel) if "username" in params:
# Set the username in the session
message.channel_session["username"] = params["username"]
# Add the user to the room_name group
Group("chat-%s" % room_name).add(message.reply_channel)
else:
# Close the connection.
message.reply_channel.send({"close": True})
# Connected to websocket.receive # Connected to websocket.receive
@channel_session @channel_session
def ws_message(message, room_name): def ws_message(message, room_name):
Group("chat-%s" % message.channel_session['room_name']).send({ Group("chat-%s" % room_name).send({
"text": message['text'], "text": message["text"],
"username": message.channel_session["username"]
}) })
# Connected to websocket.disconnect # Connected to websocket.disconnect
@ -416,9 +425,9 @@ Update ``routing.py`` as well::
from myapp.consumers import ws_connect, ws_message, ws_disconnect from myapp.consumers import ws_connect, ws_message, ws_disconnect
channel_routing = [ channel_routing = [
route("websocket.connect", ws_connect), route("websocket.connect", ws_connect, path=r"^/(?P<room_name>[a-zA-Z0-9_]+)/$"),
route("websocket.receive", ws_message), route("websocket.receive", ws_message, path=r"^/(?P<room_name>[a-zA-Z0-9_]+)/$"),
route("websocket.disconnect", ws_disconnect), route("websocket.disconnect", ws_disconnect, path=r"^/(?P<room_name>[a-zA-Z0-9_]+)/$"),
] ]
If you play around with it from the console (or start building a simple If you play around with it from the console (or start building a simple