var FramingSocket = require('framing-socket');
var socket = new FramingSocket();
var rpc_id = 123;                                   // Unique RPC ID to identify this request (unique to this connection)
 
function on_frame(err, data) {
    // do something with the returned frame (minus the frame_length bytes)
    // ....
    // got what we wanted so let's close the connection
    socket.close();
}
 
function on_connect(err) {
    if (err) {
        // oops - failed to connect...
        return;
    }
    socket.write(rpc_id, new Buffer([0x01, 0x02, 0x03]), on_frame);
}
 
socket.connect('localhost', 8888, on_connect);

var FramingSocket = require('framing-socket');
 
// these are actually the defaults
var options = {
    // Client timeout to use in milliseconds
    timeout_ms: 5000,
    // memory watermark before emitting 'pause' and 'resume'
    // events to throttle writes (hopefully)
    warn_buffer_bytes: 524288,
    // Maximum memory to buffer for a socket before
    // rejecting writes
    max_buffer_bytes: 1048576,
    // frame_length field size in bytes
    frame_length_size: 4,
    // custom writer function for the frame_length field
    frame_length_writer: function(offset_buffer, frame_length) {
        offset_buffer.writeInt32BE(frame_length);
    },
    // custom function to read the frame_length
    // note that it passes in an OffsetBuffer (see 'offset-buffer' repo)
    frame_length_reader: function(offset_buffer) {
        return offset_buffer.readInt32BE();
    },
    // rpc_id size in bytes
    rpc_id_size: 4,
    // custom writer function for the rpc_id
    rpc_id_writer: function(offset_buffer, rpc_id) {
        offset_buffer.writeInt32BE(rpc_id);
    },
    // custom reader function for the rpc_id
    rpc_id_reader: function(offset_buffer) {
        // The frame_length field is stripped from this OffsetBuffer already
        return offset_buffer.readInt32BE();
    }
};
 
var socket = new FramingSocket(options);
 
//...

framing_socket.connect(host, port, function on_connect(err) {
    if (!err) {
        // socket is now connected successfully...
    }
});

framing_socket.close();

var rpc_id = 123;
var data = new Buffer('abcd', 'utf8');
framing_socket.write(rpc_id, data, function on_frame(err, frame) {
    if (!err) {
        // got result frame (OffsetBuffer)! do something with it.
    }
});

var rpc_id = 123;
var data = new Buffer('abcd', 'utf8');
framing_socket.write(rpc_id, data, function on_frame(err, frame) {
    if (err) {
        console.log('Oops!');
    } else {
        // shouldn't get here
    }
});
 
framing_socket.fail_pending_rpcs();
// Outputs 'Oops!'

framing_socket.on('disconnected', function on_disconnected(host, port, last_err) {
    // This was unplanned.  Try to reconnect?
});

framing_socket.on('timeout', function on_timeout(host, port) {
    // Socket timed out.  Try to reconnect or fail everything?
});

framing_socket.on('pause', function on_pause(host, port) {
    // Please slow down!
});

framing_socket.on('resume', function on_resume(host, port) {
    // Ok, go nuts.
});