Websocket webserver framework in nodejs. Under development, unstable
npm install lark-websocket
The following example creates a new websocket server, and send a message back when received one
var ws = require('lark-websocket');
ws.createServer(function(client, request){
client.on('message',function(msg){
client.send("Received you message : " + msg);
});
}).listen(8023);
Attach websocket server to an HTTP server
require('lark-websocket');
var http = require('http');
http.createServer(function(req,res){...})
.acceptWebsocket(function(client, request){...})
.listen(8023);
Note that requiring websocket will extend require('net').Server with acceptWebsocket. I'm still considering, maybe will remove this later
You can extend/modify lark-websocket directly, or use the following syntactic sugar:
var websocket = require('lark-websocket');
websocket.extend(function(ws){
ws.sayHello = function(){...};
});
By default lark-websocket has been extended with application
, router
and group
Inherits events.EventEmitter, encapsulated socket.
new Client(socket)
to create a new clientclient.send
send a message, emitsend
client.receive
to receive frames. Usageclient.receive(callback)
,callback
is called when a frame received, emitreceive
client.message
to receive message. Usageclient.receive(callback)
,callback
is called when a text frame received, emitmessage
client.ping
to ping. Unfortunately, no events for this actionclient.close
to close, emitclose
- Event
error
, emit when socket eventerror
emitted