nes adds native WebSocket support to hapi-based application servers. Instead of treating the WebSocket connections as a separate platform with its own security and application context, nes builds on top of the existing hapi architecture to provide a flexible and organic extension.

Protocol version: 2.2.x (different from module version)

Lead Maintainer - Eran Hammer

• API
• Protocol
• Examples
  • Route invocation
  • Subscriptions
  • Broadcast
  • Route authentication
  • Subscription filter
• Browser Client

API

The full client and server API is available in the API documentation.

Protocol

The nes protocol is described in the Protocol documentation.

Examples

Route invocation

Server

varHapi=require('hapi');varNes=require('nes');varserver=newHapi.Server();server.connection();server.register(Nes,function(err){server.route({method: 'GET',path: '/h',config: {id: 'hello',handler: function(request,reply){returnreply('world!');}}});server.start(function(err){/* ... */});});

Client

varNes=require('nes');varclient=newNes.Client('ws://localhost');client.connect(function(err){client.request('hello',function(err,payload){// Can also request '/h'// payload -> 'world!'});});

Subscriptions

Server

varHapi=require('hapi');varNes=require('nes');varserver=newHapi.Server();server.connection();server.register(Nes,function(err){server.subscription('/item/{id}');server.start(function(err){server.publish('/item/5',{id: 5,status: 'complete'});server.publish('/item/6',{id: 6,status: 'initial'});});});

Client

varNes=require('nes');varclient=newNes.Client('ws://localhost');client.connect(function(err){varhandler=function(update,flags){// update -> { id: 5, status: 'complete' }// Second publish is not received (doesn't match)};client.subscribe('/item/5',handler,function(err){});});

Broadcast

Server

varHapi=require('hapi');varNes=require('nes');varserver=newHapi.Server();server.connection();server.register(Nes,function(err){server.start(function(err){server.broadcast('welcome!');});});

Client

varNes=require('nes');varclient=newNes.Client('ws://localhost');client.connect(function(err){client.onUpdate=function(update){// update -> 'welcome!'};});

Route authentication

Server

varHapi=require('hapi');varBasic=require('hapi-auth-basic');varBcrypt=require('bcrypt');varNes=require('nes');varserver=newHapi.Server();server.connection();server.register([Basic,Nes],function(err){// Set up HTTP Basic authenticationvarusers={john: {username: 'john',password: '$2a$10$iqJSHD.BGr0E2IxQwYgJmeP3NvhPrXAeLSaGCj6IR/XU5QtjVu5Tm',// 'secret'name: 'John Doe',id: '2133d32a'}};varvalidate=function(request,username,password,callback){varuser=users[username];if(!user){returncallback(null,false);}Bcrypt.compare(password,user.password,function(err,isValid){callback(err,isValid,{id: user.id,name: user.name});});};server.auth.strategy('simple','basic','required',{validateFunc: validate});// Configure route with authenticationserver.route({method: 'GET',path: '/h',config: {id: 'hello',handler: function(request,reply){returnreply('Hello '+request.auth.credentials.name);}}});server.start(function(err){/* ... */});});

Client

varNes=require('nes');varclient=newNes.Client('ws://localhost');client.connect({auth: {headers: {authorization: 'Basic am9objpzZWNyZXQ='}}},function(err){client.request('hello',function(err,payload){// Can also request '/h'// payload -> 'Hello John Doe'});});

Subscription filter

Server

varHapi=require('hapi');varBasic=require('hapi-auth-basic');varBcrypt=require('bcrypt');varNes=require('nes');varserver=newHapi.Server();server.connection();server.register([Basic,Nes],function(err){// Set up HTTP Basic authenticationvarusers={john: {username: 'john',password: '$2a$10$iqJSHD.BGr0E2IxQwYgJmeP3NvhPrXAeLSaGCj6IR/XU5QtjVu5Tm',// 'secret'name: 'John Doe',id: '2133d32a'}};varvalidate=function(request,username,password,callback){varuser=users[username];if(!user){returncallback(null,false);}Bcrypt.compare(password,user.password,function(err,isValid){callback(err,isValid,{id: user.id,name: user.name,username: user.username});});};server.auth.strategy('simple','basic','required',{validateFunc: validate});// Set up subscriptionserver.subscription('/items',{filter: function(path,message,options,next){returnnext(message.updater!==options.credentials.username);}});server.start(function(err){server.publish('/items',{id: 5,status: 'complete',updater: 'john'});server.publish('/items',{id: 6,status: 'initial',updater: 'steve'});});});

Client

varNes=require('nes');varclient=newNes.Client('ws://localhost');// Authenticate as 'john'client.connect({auth: {headers: {authorization: 'Basic am9objpzZWNyZXQ='}}},function(err){varhandler=function(err,update){// First publish is not received (filtered due to updater key)// update -> { id: 6, status: 'initial', updater: 'steve' }};client.subscribe('/items',handler,function(err){});});

Browser Client

When you require('nes') it loads the full module and adds a lot of extra code that is not needed for the browser. The browser will only need the nes client. If you are using CommonJS you can load the client with require('nes/client').