jsonsocket v1.0.2

jsonsocket

JSON socket

Install

$ npm install jsonsocket

Usage

var JsonSocket = require('jsonsocket');

Methods

JsonSocket(options)

JsonSocket(port, [host])

JsonSocket(path)

Create new json socket. Same as net.connect.

var socket = new JsonSocket(7000, '127.0.0.1');

JsonSocket(socket)

Create new json socket from existingnet.Socket

var net = require('net');
var server = net.createServer(function (con) {
    var socket = new JsonSocket(con);
}

write(data)

Send object over socket.

socket.write({foo: 'bar'});

disconnect()

Destroy connection

connect(port, [host])

connect(path)

Same as net.Socket.connect

on(eventType, listener)

Inherited from events.EventEmitter.

Events

connect

Emitted when socket connected (only when you pass ip, port).

json

Emitted when full json received.

socket.on('json', function (json) {
    console.log(json);
}

disconnect

Emitted when disconnected.

error

Emitted when net.Socket emit error.

Error events are treated as a special case in node. If there is no listener for it, then the default action is to print a stack trace and exit the program.

see more.

newListener, removeListener

Inherited from EventEmitter.

Logging

You can enable logging. See more

# disabled logging
node test.js

# connect, disconnect log
DEBUG=JsonSocket:connection node test.js

# data log
DEBUG=JsonSocket:data node test.js

# all json socket logs
DEBUG=JsonSocket:* node test.js

Protocol

We send json objects over socket then write one \0. This is c/c++ friendly protocol. :smile:

{"x": 3}\0null\0"Hi"\0[]\0