Websocket Client & Server Library implementing the WebSocket protocol as specified in RFC 6455.
Version 1.0.7 requires node v0.6.10, since that's the first version that I can manage to successfully build the native extensions with node-gyp through npm. If anyone can figure out how to build native extensions in a way that works with both older and newer versions of Node, I'm happy to accept a patch!
Current Version: 1.0.8
- Firefox 7-9 (Old) (Protocol Version 8)
- Firefox 10+ (Protocol Version 13)
- Chrome 14,15 (Old) (Protocol Version 8)
- Chrome 16+ (Protocol Version 13)
- Internet Explorer 10 (Preview) (Protocol Version 13)
- Safari 6 (Protocol Version 13)
Safari older than 6.0 is not supported since it uses a very old draft of WebSockets
I made a decision early on to explicitly avoid maintaining multiple slightly different copies of the same code just to support the browsers currently in the wild. The major browsers that support WebSocket are on a rapid-release schedule (with the exception of Safari) and now that the final version of the protocol has been published as an official RFC, it won't be long before support in the wild stabilizes on that version. My client application is in Flash/ActionScript 3, so for my purposes I'm not dependent on the browser implementations. I made an exception to my stated intention here to support protocol version 8 along with 13, since only one minor thing changed and it was trivial to handle conditionally. The library now interoperates with other clients and servers implementing draft -08 all the way up through the final RFC.
If you need to simultaneously support legacy browser versions that had implemented draft-75/draft-76/draft-00, take a look here: https://gist.github.com/1428579
For a WebSocket client written in ActionScript 3, see my AS3WebScocket project.
There are some basic benchmarking sections in the Autobahn test suite. I've put up a benchmark page that shows the results from the Autobahn tests run against AutobahnServer 0.4.10, WebSocket-Node 1.0.2, WebSocket-Node 1.0.4, and ws 0.3.4.
The very complete Autobahn Test Suite is used by most WebSocket implementations to test spec compliance and interoperability.
This library has been used in production on worlize.com since April 2011 and seems to be stable. Your mileage may vary.
Tested with the following node versions:
It may work in earlier or later versions but I'm not actively testing it outside of the listed versions. YMMV.
For more complete documentation, see the Documentation Wiki.
A few users have reported difficulties building the native extensions without first manually installing node-gyp. If you have trouble building the native extensions, make sure you've got a C++ compiler, and have done
npm install -g node-gyp first.
Native extensions are optional, however, and WebSocket-Node will work even if the extensions cannot be compiled.
In your project root:
$ npm install websocket
Then in your code:
var WebSocketServer = require'websocket'server;var WebSocketClient = require'websocket'client;var WebSocketFrame = require'websocket'frame;var WebSocketRouter = require'websocket'router;
Because there is a small C++ component used for validating UTF-8 data, you will need to install a few other software packages in addition to Node to be able to build this module:
- Licensed under the Apache License, Version 2.0
- Protocol version "8" and "13" (Draft-08 through the final RFC) framing and handshake
- Can handle/aggregate received fragmented messages
- Can fragment outgoing messages
- Router to mount multiple applications to various path and protocol combinations
- TLS supported for outbound connections via WebSocketClient
- TLS supported for server connections (use https.createServer instead of http.createServer)
- Thanks to pors for confirming this!
- Cookie setting and parsing
- Tunable settings
- Max Receivable Frame Size
- Max Aggregate ReceivedMessage Size
- Whether to fragment outgoing messages
- Fragmentation chunk size for outgoing messages
- Whether to automatically send ping frames for the purposes of keepalive
- Keep-alive ping interval
- Whether or not to automatically assemble received fragments (allows application to handle individual fragments directly)
- How long to wait after sending a close frame for acknowledgment before closing the socket.
- No API for user-provided protocol extensions.
Here's a short example showing a server that echos back anything sent to it, whether utf-8 or binary.
#!/usr/bin/env nodevar WebSocketServer = require'websocket'server;var http = require'http';var server = httpcreateServerconsole.log + ' Received request for ' + requesturl;responsewriteHead404;responseend;;serverlisten8080console.log + ' Server is listening on port 8080';;wsServer =httpServer: server// You should not use autoAcceptConnections for production// applications, as it defeats all standard cross-origin protection// facilities built into the protocol and the browser. You should// *always* verify the connection's origin and decide whether or not// to accept it.autoAcceptConnections: false;// put logic here to detect whether the specified origin is allowed.return true;wsServeron'request'if !originIsAllowedrequestorigin// Make sure we only accept requests from an allowed originrequestreject;console.log + ' Connection from origin ' + requestorigin + ' rejected.';return;var connection = requestaccept'echo-protocol' requestorigin;console.log + ' Connection accepted.';connectionon'message'if messagetype === 'utf8'console.log'Received Message: ' + messageutf8Data;connectionsendUTFmessageutf8Data;else if messagetype === 'binary'console.log'Received Binary Message of ' + messagebinaryDatalength + ' bytes';connectionsendBytesmessagebinaryData;;connectionon'close'console.log + ' Peer ' + connectionremoteAddress + ' disconnected.';;;
This is a simple example client that will print out any utf-8 messages it receives on the console, and periodically sends a random number.
This code demonstrates a client in Node.js, not in the browser
#!/usr/bin/env nodevar WebSocketClient = require'websocket'client;var client = ;clienton'connectFailed'console.log'Connect Error: ' + errortoString;;clienton'connect'console.log'WebSocket client connected';connectionon'error'console.log"Connection Error: " + errortoString;;connectionon'close'console.log'echo-protocol Connection Closed';;connectionon'message'if messagetype === 'utf8'console.log"Received: '" + messageutf8Data + "'";;if connectionconnectedvar number = MathroundMathrandom * 0xFFFFFF;connectionsendUTFnumbertoString;setTimeoutsendNumber 1000;sendNumber;;clientconnect'ws://localhost:8080/' 'echo-protocol';
For an example of using the request router, see
libwebsockets-test-server.js in the
A presentation on the state of the WebSockets protocol that I gave on July 23, 2011 at the LA Hacker News meetup. WebSockets: The Real-Time Web, Delivered