msgpack-sock

Msgpack wrap for net.Socket and tls.TLSSocket

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
msgpack-sock
1.1.07 years ago7 years agoMinified + gzip package size for msgpack-sock in KB

Readme

MsgpackSock
Msgpack wrap for net.Socket and tls.TLSSocket

Installation

npm install --save msgpack-sock

Using

const net = require('net');
const MsgpackSock = require('msgpack-sock');

//echo server
net.createServer(MsgpackSock.createConnectionHandler(socket => {
    socket.on('message', msg => socket.send(msg));
})).listen(3000);

//client
const socket = MsgpackSock.wrap(net.createConnection(3000));
socket.on('message', msg => console.log(msg));
socket.send('string');
socket.send(true);
socket.send({
    str: 'string',
    arrOfNumbers: [1 ,2 , 3],
    bool: false,
    buffer: Buffer.from('buffer', 'utf-8')
});

Api

Static methods

  • MsgpackSock.createConnectionHandler (callback: function(socket: MsgpackSock), codec: ?msgpackLite.Codec): function(socket: net.Socket | tls.TLSSocket)
  • MsgpackSock.wrap (socket: net.Socket | tls.TLSSocket, codec: ?msgpackLite.Codec): MsgpackSock
  • MsgpackSock.createCodec - see
  • MsgpackSock.encode - see
  • MsgpackSock.decode - see

Events

  • message (msg: any) - New message received
  • close () - Socket closed
  • error (err: Error) - Received error
  • connect - transfered from net.Socket
  • drain - transfered from net.Socket
  • lookup - transfered from net.Socket
  • timeout - transfered from net.Socket
  • OCSPResponse - transfered from tls.TLSSocket
  • secureConnect - transfered from tls.TLSSocket

Methods

  • send (msg: any) - Send message
  • close () - Close connection
  • address - from net.Socket
  • setKeepAlive - from net.Socket
  • setNoDelay - from net.Socket
  • setTimeout - from net.Socket
  • ref - from net.Socket
  • unref - from net.Socket
  • getCipher = from tls.TLSSocket
  • getEphemeralKeyInfo = from tls.TLSSocket
  • getPeerCertificate = from tls.TLSSocket
  • getProtocol = from tls.TLSSocket
  • getSession = from tls.TLSSocket
  • getTLSTicket = from tls.TLSSocket
  • renegotiate = from tls.TLSSocket
  • setMaxSendFragment = from tls.TLSSocket