diff options
| author | Joel Martin <github@martintribe.org> | 2011-01-13 00:17:01 -0600 |
|---|---|---|
| committer | Joel Martin <github@martintribe.org> | 2011-01-13 00:17:01 -0600 |
| commit | 124f28c63ac451eba9f248714c6d6e4b0f2a8b58 (patch) | |
| tree | 06402fb82fe8c7f0d0c909590143ba06d97a51b4 /README.md | |
| parent | 6d1e216115d5ab84dafed0c91c40f58f7857c877 (diff) | |
| download | websockify-124f28c63ac451eba9f248714c6d6e4b0f2a8b58.tar.gz | |
include/websock.js: client library for websockify.
The Websock object from websock.js is similar to the standard
WebSocket object but Websock enables communication with raw TCP
sockets (i.e. the binary stream) via websockify. This is accomplished
by base64 encoding the data stream between Websock and websockify.
Websock has built-in receive queue buffering; the message event
does not contain actual data but is simply a notification that
there is new data available. Several rQ* methods are available to
read binary data off of the receive queue.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 16 insertions, 2 deletions
@@ -1,6 +1,6 @@ ## websockify: WebSockets support for any application/server -websockify was formerly named `wsproxy` and was part of the +websockify was formerly named wsproxy and was part of the [noVNC](https://github.com/kanaka/noVNC) project. At the most basic level, websockify just translates WebSockets traffic @@ -15,6 +15,20 @@ case the data from the client is not a full WebSockets frame (i.e. does not end in 255). +### Websock Javascript library + +The `include/websock.js` Javascript library library provides a Websock +object that is similar to the standard WebSocket object but Websock +enables communication with raw TCP sockets (i.e. the binary stream) +via websockify. This is accomplished by base64 encoding the data +stream between Websock and websockify. + +Websock has built-in receive queue buffering; the message event +does not contain actual data but is simply a notification that +there is new data available. Several rQ* methods are available to +read binary data off of the receive queue. + + ### Additional websockify features These are not necessary for the basic operation. @@ -49,7 +63,7 @@ These are not necessary for the basic operation. The primary implementation of websockify is in python. There are two other implementations of websockify in C, and Node (node.js) in the -`other` directory. +`other/` subdirectory. Here is the feature support matrix for the the websockify implementations: |