json-over-tcp

TCP server/client messaging in JSON

jot (json-over-tcp)

Node.js TCP server/client messaging in JSON.

This library provides a server and a socket class (with APIs that are very similar to the net package in Node.js) which communicate by sending each other JSON messages.

You "write" JSON objects to the socket, and the "data" events on the other end of the socket emits the JSON object you wrote.

// assume that I have a jot server listening somewhere and I created a connection to it called "connection" 
var someObject = {
  "this property is null": null,
  1928: 3734,
  turtle: {
    neck: "sweater"
  }
};
 
connection.write(someObject);
// Whatever is listening to this connection on the server-side will now recieve a "data" event with an object that 
// has the same values as "someObject". 
// This script will output "Client's question: Hello, world?" and "Server's answer: 42" in alternating order 
// every second until the script is stopped. 
 
var someRandomPort = 8099,
  jot = require('json-over-tcp');
 
var server = jot.createServer(someRandomPort);
server.on('listening', createConnection);
server.on('connection', newConnectionHandler);
 
// Triggered whenever something connects to the server 
function newConnectionHandler(socket){
  // Whenever a connection sends us an object... 
  socket.on('data', function(data){
    // Output the question property of the client's message to the console 
    console.log("Client's question: " + data.question);
 
    // Wait one second, then write an answer to the client's socket 
    setTimeout(function(){
      socket.write({answer: 42});
    }, 1000);
  });
};
 
// Creates one connection to the server when the server starts listening 
function createConnection(){
  // Start a connection to the server 
  var socket = jot.connect(someRandomPort, function(){
    // Send the initial message once connected 
    socket.write({question: "Hello, world?"});
  });
  
  // Whenever the server sends us an object... 
  socket.on('data', function(data){
    // Output the answer property of the server's message to the console 
    console.log("Server's answer: " + data.answer);
    
    // Wait one second, then write a question to the socket 
    setTimeout(function(){
      // Notice that we "write" a JSON object to the socket 
      socket.write({question: "Hello, world?"});
    }, 1000);
  });
}
 
// Start listening 
server.listen(someRandomPort);

Factory function for creating a jot server -- same options as net.createServer([options], [connectionListener]) in the Node.js net module documentation.

Factory function for creating a jot socket -- same options as net.connect(options, [connectionListener]) in the Node.js net module documentation.

Factory function for creating a jot socket -- same options as net.createConnection(options, [connectionListener]) in the Node.js net module documentation.

Factory function for creating a jot socket -- same options as net.connect(port, [host], [connectListener]) in the Node.js net module documentation.

Factory function for creating a jot socket -- same options as net.createConnection(port, [host], [connectListener]) in the Node.js net module documentation.

Factory function for creating a jot socket -- same options as net.connect(path, [connectListener]) in the Node.js net module documentation.

Factory function for creating a jot socket -- same options as net.createConnection(path, [connectListener]) in the Node.js net module documentation.

Factory function for creating a jot protocol object.

Factory function for creating a jot socket.

The server API is the same as the Server API in the native 'net' module with the following differences:

Emits a jot socket (see it's API below) instead of a plain tcp socket.

The socket API is the same as the Socket API in the native 'net' module with the following differences:

Emits a JSON object which was sent by the other end of the socket.

Sends an object to the other end of the socket. This method doesn't accept any of the other parameters as the plain tcp socket.

The protocol object is what serializes/deserializes JSON data over the wire.

Takes in a Stream object and reads/writes JSON objects using it's a simple protocol (a protocol signature, message length, and stringified JSON).

Writes an object which can be stringified to the stream.

Bind to an event ('data' is the only one ever emitted).

Remove a bound listener.

Emits a JSON object whenever a stream message is recieved.