django/daphne
1
1
Fork 0
mirror of https://github.com/django/daphne.git synced 2025-07-14 18:02:17 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updates to data binding docs (#283)

Browse Source
This commit is contained in:
Emett Speer 2016-08-02 17:33:07 -07:00 committed by Andrew Godwin
parent 04a1296222
commit 7d85dec8fa
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/binding.rst
View File

@ -9,7 +9,7 @@ Data Binding
The Channels data binding framework automates the process of tying Django The Channels data binding framework automates the process of tying Django
models into frontend views, such as javascript-powered website UIs. It provides models into frontend views, such as javascript-powered website UIs. It provides
a quick and flexible way to generate messages on Groups for model changes a quick and flexible way to generate messages on Groups for model changes
and to accept messages that chanes models themselves. and to accept messages that change models themselves.
The main target for the moment is WebSockets, but the framework is flexible The main target for the moment is WebSockets, but the framework is flexible
enough to be used over any protocol. enough to be used over any protocol.
@ -20,9 +20,9 @@ What does data binding allow?
Data binding in Channels works two ways: Data binding in Channels works two ways:
* Outbound, where model changes made through Django are sent out to listening * Outbound, where model changes made through Django are sent out to listening
clients. This includes creation, update and deletion of instances. clients. This includes creation, updates and deletion of instances.
* Inbound, where a standardised message format allow creation, update and * Inbound, where a standardised message format allows creation, update and
deletion of instances to be made by clients sending messages. deletion of instances to be made by clients sending messages.
Combined, these allow a UI to be designed that automatically updates to Combined, these allow a UI to be designed that automatically updates to
@ -51,7 +51,9 @@ or permission checks, for example).
You can inherit from the base Binding and provide all the methods needed, but You can inherit from the base Binding and provide all the methods needed, but
we'll focus on the WebSocket JSON variant here, as it's the easiest thing to we'll focus on the WebSocket JSON variant here, as it's the easiest thing to
get started and likely close to what you want. Start off like this:: get started and likely close to what you want.
Start off like this::
from django.db import models from django.db import models
from channels.binding.websockets import WebsocketBinding from channels.binding.websockets import WebsocketBinding