diff options
| author | Joel Martin <github@martintribe.org> | 2011-10-06 16:55:10 -0500 |
|---|---|---|
| committer | Joel Martin <github@martintribe.org> | 2011-10-06 16:55:10 -0500 |
| commit | 40868636dac4267355baf1591decdd30be7580e6 (patch) | |
| tree | c07f8c9e4817ec7d4a9e33c6136e20aa248ef5fd /README.md | |
| parent | f69ac8e0a01d54ab8d1741e1b05d4888e7a6b63b (diff) | |
| download | websockify-40868636dac4267355baf1591decdd30be7580e6.tar.gz | |
Link to API page. Default length for rQshift*
If no length parameter is given to rQshiftStr or rQshiftBytes, then
the all remaining data (the full length) will be shifted off.
Also, honor the window.WEB_SOCKET_FORCE_FLASH variable to force
web-socket-js to be used even if the browser has native WebSockets
support.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 3 |
1 files changed, 3 insertions, 0 deletions
@@ -19,6 +19,7 @@ not affect the data between websockify and the server. ### 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) @@ -30,6 +31,8 @@ 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. +The Websock API is documented on the [websock.js API wiki page](https://github.com/kanaka/websockify/wiki/websock.js) + See the "Wrap a Program" section below for an example of using Websock and websockify as a browser telnet client (`wstelnet.html`). |