Overview

Documentation

Changelog

Browser Support

Benchmarks

Autobahn Tests

Installation

$ npm install websocket

varWebSocketServer=require('websocket').server;varWebSocketClient=require('websocket').client;varWebSocketFrame=require('websocket').frame;varWebSocketRouter=require('websocket').router;varW3CWebSocket=require('websocket').w3cwebsocket;

Current Features:

Known Issues/Missing Features:

Usage Examples

Server Example

#!/usr/bin/env nodevarWebSocketServer=require('websocket').server;varhttp=require('http');varserver=http.createServer(function(request,response){console.log((newDate())+' Received request for '+request.url);response.writeHead(404);response.end();});server.listen(8080,function(){console.log((newDate())+' Server is listening on port 8080');});wsServer=newWebSocketServer({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});functionoriginIsAllowed(origin){// put logic here to detect whether the specified origin is allowed.returntrue;}wsServer.on('request',function(request){if(!originIsAllowed(request.origin)){// Make sure we only accept requests from an allowed originrequest.reject();console.log((newDate())+' Connection from origin '+request.origin+' rejected.');return;}varconnection=request.accept('echo-protocol',request.origin);console.log((newDate())+' Connection accepted.');connection.on('message',function(message){if(message.type==='utf8'){console.log('Received Message: '+message.utf8Data);connection.sendUTF(message.utf8Data);}elseif(message.type==='binary'){console.log('Received Binary Message of '+message.binaryData.length+' bytes');connection.sendBytes(message.binaryData);}});connection.on('close',function(reasonCode,description){console.log((newDate())+' Peer '+connection.remoteAddress+' disconnected.');});});

Client Example

#!/usr/bin/env nodevarWebSocketClient=require('websocket').client;varclient=newWebSocketClient();client.on('connectFailed',function(error){console.log('Connect Error: '+error.toString());});client.on('connect',function(connection){console.log('WebSocket Client Connected');connection.on('error',function(error){console.log("Connection Error: "+error.toString());});connection.on('close',function(){console.log('echo-protocol Connection Closed');});connection.on('message',function(message){if(message.type==='utf8'){console.log("Received: '"+message.utf8Data+"'");}});functionsendNumber(){if(connection.connected){varnumber=Math.round(Math.random()*0xFFFFFF);connection.sendUTF(number.toString());setTimeout(sendNumber,1000);}}sendNumber();});client.connect('ws://localhost:8080/','echo-protocol');

Client Example using theW3C WebSocket API

varW3CWebSocket=require('websocket').w3cwebsocket;varclient=newW3CWebSocket('ws://localhost:8080/','echo-protocol');client.onerror=function(){console.log('Connection Error');};client.onopen=function(){console.log('WebSocket Client Connected');functionsendNumber(){if(client.readyState===client.OPEN){varnumber=Math.round(Math.random()*0xFFFFFF);client.send(number.toString());setTimeout(sendNumber,1000);}}sendNumber();};client.onclose=function(){console.log('echo-protocol Client Closed');};client.onmessage=function(e){if(typeofe.data==='string'){console.log("Received: '"+e.data+"'");}};

Request Router Example

Resources