connection
TypeScript icon, indicating that this package has built-in type declarations

1.4.0 • Public • Published

connection

connection socket wrapper

NPM version build status Test coverage David deps Known Vulnerabilities npm download

Usage

Client Socket

const net = require('net');
const awaitFirst = require('await-first');
const Connection = require('connection');
 
const Decoder = require('sofa-bolt-node/lib/decoder');
const Encoder = require('sofa-bolt-node/lib/encoder');
// bolt protocol example
const protocol = {
  name: 'Rpc',
  encoder: opts => new Encoder(opts),
  decoder: opts => new Decoder(opts),
};
 
async function createConnection(hostname, port) {
  const socket = net.connect(port, hostname);
  await awaitFirst(socket, [ 'connect', 'error' ]);
  return new Connection({
    logger: console,
    socket,
    protocol,
  });
}
 
const conn = await createConnection('127.0.0.1', 12200);
 
conn.writeRequest({
  targetAppName: 'foo',
  args: [ 'peter' ],
  serverSignature: 'com.alipay.sofa.rpc.quickstart.HelloService:1.0',
  methodName: 'sayHello',
  methodArgSigs: [ 'java.lang.String' ],
  requestProps: null,
});
 

Server Socket

const Connection = require('connection');
const server = net.createServer();
server.listen(port);
 
server.on('connection', sock => {
  const conn = new Connection({
    logger: console,
    socket: sock,
    protocol,
  });
  
  conn.on('request', req => {
    conn.writeResponse(req, {
      error: null,
      appResponse: 'hello, peter',
      responseProps: null,
    });
  });
});

More example

API

  • oneway() - one way call
  • async writeRequest(req) - write request and wait response
  • async writeResponse(req, res) - write response
  • async close() - wait all pending request done and destroy the socket
  • async forceClose() - abort all pending request and destroy the socket
  • get protocolOptions() - encoder/decoder constructor options, can be overwrite when custom protocol

Protocol implement

interface Request {
  /**
   * If request is oneway, shoule set to true
   */
  oneway: boolean,
  /**
   * writeRequest will use the timeout to set the timer
   */
  timeout: number,
  /**
   * request packet type, request|heartbeat|response 
   */
  packetType: string,
}
 
interface Response {
  packetId: number,
}
 
interface Encoder extends Transform {
  /**
   * write request to socket
   * Connection#writeRequest and Connection#oneway will call the function.
   * @param {number} id - the request id
   * @param {Object} req - the request object should be encoded
   * @param {Function} cb - the encode callback
   */
  writeRequest(id: number, req: object, cb);
  /**
   * write response to socket
   * Connection#writeResponse will call the function.
   * @param {Object} req - the request object
   * @param {Object} res - the response object should be encoded
   * @param {Function} cb - the encode callback
   */
  writeResponse(req: object, res: object, cb);
}
 
interface Decoder extends Writable {
  // events
  // - request emit when have request packet
  // - heartbeat emit when have heartbeat packet
  // - response emit when have response packet
}
 
interface Protocol {
  name: string;
  encode(options: any): Encoder;
  decode(options: any): Decoder;
}

Readme

Keywords

Package Sidebar

Install

npm i connection

Weekly Downloads

668

Version

1.4.0

License

MIT

Unpacked Size

17.9 kB

Total Files

7

Last publish

Collaborators

  • gxcsoccer
  • popomore
  • killagu