Yakety

Bi-directional node to node messaging and request-reply.

Both the server and client can send and receive messages as well as requests-replys.

Yakety is a bit like a RESTful service, but allows the server to instigate requests to the client, plus fire-and-forget messages. Yakety will also maintain persistent connections by automatically reconnecting clients. Yakety is for back-end node to node communications, not a browser compatible solution.

Installation

npm install yakety

Examples

See examples folder.

Server example

const yakety = require('yakety');
 
var options = {
  protocol: 'ws',            // or 'wss' for secure.
  slowHandshake: true,      // true: can do your own authorization and handshake or close socket.
  port: 8080
};
 
 
var server = new yakety.server();
 
server.bind(options);
 
// auth clients:
server.on('authorize', function(client) {
  console.log('authorize client');
 
  if ( !client.headers.authorization ) {
    client.goodbye(401);
  } else if ( client.headers.authorization.password === 'password' ) {
    client.handshake();
  } else {
    client.goodbye(401);
  }
 
});
 
server.on('connected', function(client) {
  console.log('client connected');
  client.request('yakMethod', 'yakety yak?', function(err, reply) {
    if ( err ) {
      console.log('client.request reply error', err);
      return;
    }
    console.log('got reply back:', reply.toString());
    client.message('this is rock and roll.');
  });
 
  client.on('message', function(message, meta) {
    console.log('server got message:', message.toString());
  });
 
  client.on('request', function(meta, req, rep) {
    console.log('got request, method: ' + meta.method + ', req:', req.toString());
    rep('yak!');
  });
 
  client.on('close', function(client) {
    console.log('client close-ed');
  });
 
});
 

Client example

const yakety = require('yakety');
 
var options = {
  protocol: 'ws',      // or 'wss' for secure.
  hostname: '127.0.0.1',
  port: 8080,
  path: '/foo/bar/?hello=world',
  auth: 'username:password'
};
 
var client = new yakety.client();
 
client.connect(options);
 
client.message('hello');
 
client.request('yaketyyakMethod', 'yakety?', function(err, reply) {
  if ( err ) {
    console.log('client.request reply error', err);
    return;
  }
  console.log('got reply to yakety?:', reply.toString());
});
 
client.on('message', function(message, meta) {
  console.log('got message:', message.toString());
});
 
client.on('request', function(meta, req, rep) {
  console.log('got request, method: ' + meta.method + ', req:', req.toString());
  rep('Talking back!');
});
 
client.on('error', function(err) {
  console.log('client-app-err', err);
});
 

Test

npm test

Notes

Yakety is built on top of these open protocols: naked-websocket for TCP/TLS network link and SMP for message framing, with any payload codec: String, Buffer, JSON, MsgPack, etc.

License

Choose either: MIT or Apache 2.0.