nssocket 技术文档

1. 安装指南

安装方式

nssocket 是一个基于 Node.js 的轻量级 TCP/TLS 协议库，可以通过 npm 进行安装。安装命令如下：

[sudo] npm install nssocket

依赖环境

• Node.js 版本：>= 12.0.0
• npm 版本：>= 6.0.0

2. 项目的使用说明

概述

nssocket 提供了一种优雅的方式来定义基于 TCP/TLS 的轻量级协议。它自动处理了消息的序列化和反序列化，并提供了默认的重连逻辑，简化了开发者在 Node.js 中处理网络协议的复杂性。

主要功能

1. 事件命名空间：利用 EventEmitter2 的通配符和命名空间功能，简化了事件处理。
2. 自动序列化与反序列化：消息通过 .send() 方法发送时会自动序列化为 JSON 数组，接收时自动反序列化。
3. 重连逻辑：默认实现了重连逻辑，适用于可能不稳定的连接。
4. TLS 支持：自动将 TCP 连接包装为 TLS 连接。

消息格式

nssocket 中的消息格式为 JSON 数组，形式如下：

["namespace", "to", "event", { "this": "is", "the": "payload" }]

简单示例

以下是一个简单的使用示例，展示了如何创建一个 nssocket 服务器并进行通信：

var nssocket = require('nssocket');

// 创建一个 nssocket TCP 服务器
var server = nssocket.createServer(function (socket) {
  socket.send(['you', 'there']);
  socket.data(['iam', 'here'], function (data) {
    console.dir(data);
  });
});

server.listen(6785);

var outbound = new nssocket.NsSocket();
outbound.data(['you', 'there'], function () {
  outbound.send(['iam', 'here'], { iam: true, indeedHere: true });
});

outbound.connect(6785);

重连示例

nssocket 提供了简单的重连选项，默认情况下这些选项是禁用的。以下是一个启用重连的示例：

var net = require('net'),
    nssocket = require('nssocket');

net.createServer(function (socket) {
  setTimeout(function () {
    socket.destroy();
  }, 1000);
}).listen(8345);

var socket = new nssocket.NsSocket({
  reconnect: true,
  type: 'tcp4',
});

socket.on('start', function () {
  console.dir('start');
});

socket.connect(8345);

3. 项目API使用文档

socket.send(event, data)

向套接字写入 data，并指定 event。接收端将收到类似 JSON.stringify([event, data]) 的消息。

socket.on(event, callback)

与底层套接字的 .addListener() 或 .on() 方法等效，支持 EventEmitter2 的通配符和命名空间。

socket.data(event, callback)

用于在 data 事件下进行简写监听的辅助函数。例如：

someSocket.on(['data', 'some', 'event'], function (data) { });
someSocket.data(['some', 'event'], function (data) { });

socket.connect(port[, host, callback])

等效于底层套接字的 .connect() 方法，并增加了参数错误处理。

socket.end()

关闭当前套接字，触发 close 事件，可能还会触发 error 事件。

socket.destroy()

移除所有监听器，销毁套接字，清空缓冲区。建议使用 socket.end()。

4. 项目安装方式

通过 npm 安装

使用以下命令安装 nssocket：

[sudo] npm install nssocket

测试

所有测试使用 vows 编写，可以通过 npm 运行测试：

$ npm test

作者与贡献者

• 作者：Nodejitsu
• 贡献者：Paolo Fragomeni, Charlie Robbins, Jameson Lee, Gene Diaz Jr.