README: no longer supporting Hixie.

NOTE: Hixie support is in version 0.4.X. If necessary, I will branch
and apply critical fixes release a new 0.4.X tagged version.
This commit is contained in:
Joel Martin 2013-03-12 13:54:11 -05:00
parent 5a726c2e4d
commit d3865688c8
2 changed files with 10 additions and 18 deletions

View File

@ -10,25 +10,17 @@ the target in both directions.
### WebSockets binary data ### WebSockets binary data
Websockify 0.4.X supports all versions of the WebSockets protocol Starting with websockify 0.5.0, only the HyBi / IETF
(Hixie and HyBi). Starting with websockify 0.5.0, only the HyBi / IETF
6455 WebSocket protocol is supported. 6455 WebSocket protocol is supported.
The older Hixie versions of the protocol only support UTF-8 text Websockify negotiates whether to base64 encode traffic to and from the
payloads. In order to transport binary data over UTF-8 an encoding client via the subprotocol header (Sec-WebSocket-Protocol). The valid
must used to encapsulate the data within UTF-8. With Hixie clients, subprotocol values are 'binary' and 'base64' and if the client sends
Websockify uses base64 to encode all traffic to and from the client. both then the server (the python implementation) will prefer 'binary'.
This does not affect the data between websockify and the server. The 'binary' subprotocol indicates that the data will be sent raw
using binary WebSocket frames. Some HyBi clients (such as the Flash
With HyBi clients, websockify negotiates whether to base64 encode fallback and older Chrome and iOS versions) do not support binary data
traffic to and from the client via the subprotocol header which is why the negotiation is necessary.
(Sec-WebSocket-Protocol). The valid subprotocol values are 'binary'
and 'base64' and if the client sends both then the server (the python
implementation) will prefer 'binary'. The 'binary' subprotocol
indicates that the data will be sent raw using binary WebSocket
frames. Some HyBi clients (such as the Flash fallback and older Chrome
and iOS versions) do not support binary data which is why the
negotiation is necessary.
### Encrypted WebSocket connections (wss://) ### Encrypted WebSocket connections (wss://)

View File

@ -1,6 +1,6 @@
from setuptools import setup, find_packages from setuptools import setup, find_packages
version = '0.4.1' version = '0.5.0-pre'
name = 'websockify' name = 'websockify'
long_description = open("README.md").read() + "\n" + \ long_description = open("README.md").read() + "\n" + \
open("CHANGES.txt").read() + "\n" open("CHANGES.txt").read() + "\n"