组装WS/cWS

为 Node.js 快速 WebSocket 执行

重要说明

• 此寄存器为 uWebSockets v0.14 (英语) 因此,有两个许可证 麻省理工学院 财务报告和审定财务报表 津巴布韦
• 考虑使用最新的 uWebSockets (中文(简体) ) 版本改为
• 你可以支持我通过 帕特伦 财务报告和审定财务报表 付费页

支持的节点版本

文档

有用链接

• 实例
• 更改日志

目录

• 安装
• 网页客户端
• Websocket 服务器
• 安全 WebSocket 软件
• 在浏览器中处理 App Level Ping (例)

安装

npm i @clusterws/cws

网页客户端

键入 : d.ts 客户

导入 cws WebSocket :

const { WebSocket } = require('@clusterws/cws');

连接到 WebSocket 服务器 :

const socket = new WebSocket(/* ws server endpoint **/);

活动 open 当服务器接受连接并准备执行其它动作时, 将触发:

socket.on('open', () => { });
// or like browser interface
socket.onopen = () => { };

活动 error 如果连接出错, 将触发 :

socket.on('error', (err) => { });
// or like browser interface
socket.onerror = (err) => { };

活动 close 当连接被关闭时被触发 :

// code: number and reason: string are optional
socket.on('close', (code, reason) => { });
// or like browser interface
socket.onclose = (code, reason) => { };

活动 message 当客户端收到信件时触发 :

// receives string or binary

socket.on('message', (message) => { });
// or like browser interface
socket.onmessage = (message) => { };

活动 ping 当另一方发送 ping 检查连接是否仍在活动时, 将触发 :

socket.on('ping', () => { });

活动 pong 于 ping 已发送, 并收到回复:

socket.on('pong', () => { })

要发送信件使用 send 函数 :

// send accepts string or binary
// will automatically identify type
socket.send(msg);

// will overwrite/specify message type to string (does not transform data to specified type)
socket.send(msg, { binary: false });

// will overwrite/specify message type to binary (does not transform data to specified type)
socket.send(msg, { binary: true });

// will call callback after message sent or errored
socket.send(msg, null, (err) => { });

要关闭连接, 您可以使用 close 或者说 terminate 方法:

// clean close code and reason are optional
socket.close(code, reason);
// destroy socket 
socket.terminate()

使用 ping 函数可手动发送 ping :

socket.ping();
// now just wait for `pong` event

要得到当前套接字准备状态可以使用 readyState 获取器 :

socket.readyState; // -> OPEN (1) or CLOSED (3)

// check if socket open can be done by
if(socket.readyState === socket.OPEN) {}

// check if socket closed can be done by
if(socket.readyState === socket.CLOSED) {}

获取地址使用 _socket 获取器 :

socket._socket;

// Returns some thing like (all fields could be undefined):
// {
//  remotePort,
//  remoteAddress,
//  remoteFamily
// }

更多信息检查打字(*.d.ts文件在 数字 文件夹

Websocket 服务器

键入 : 离/服务器.d.ts

导入 cws WebSocket :

const { WebSocket } = require('@clusterws/cws');

创建 WebSocket 服务器 :

const wsServer = new WebSocket.Server({ 
  /**
   * port?: number (creates server and listens on provided port)
   * host?: string (provide host if necessary with port)
   * path?: string (url at which accept ws connections)
   * server?: server (provide already existing server)
   * noDelay?: boolean (set socket no delay)
   * noServer?: boolean (use this when upgrade done outside of cws)
   * maxPayload?: number 
   * perMessageDeflate?: boolean | { serverNoContextTakeover: boolean;}
   * verifyClient?: (info: ConnectionInfo, next: VerifyClientNext) => void (use to allow or decline connections)
   **/ 
 }, () => {
  // callback called when server is ready
  // is not called when `noServer: true` or `server` is provided
  // from outside
});

活动 connection 当新客户端连接到服务器时触发 :

// `ws` is websocket client all available options 
// can be found in `Websocket Client` section above
// `req` is http upgrade request
wsServer.on('connection', (ws, req) => {})

活动 error 当服务器出现一些问题时触发 noServer 实值 false:

// on error event will NOT include httpServer errors IF
// server was passed under server parameter { server: httpServer },
// you can register on 'error' listener directly on passed server
wsServer.on('error', (err) => { })

活动 close 在您拨打后触发 wsServer.close() 函数,如果 cb 两者均提供 cb 继续 close 将触发听众 :

wsServer.on('close', () => { })

让所有连接的客户端使用 clients 获取器 :

wsServer.clients;

// loop thought all clients:
wsServer.clients.forEach((ws) => { });

// get number of clients:
wsServer.clients.length;

向所有使用的连接客户端发送信件 broadcast 方法 :

// broadcast string
wsServer.broadcast(message);

// broadcast binary
wsServer.broadcast(message, { binary: true });

cWS 支持自动拨打 startAutoPing 函数 :

wsServer.startAutoPing(interval, appLevel);

// send ping to each client every 10s and destroy client if no pong received 
wsServer.startAutoPing(10000);

// pass true as second parameter to run app level ping
// this is mainly used for browser to track pings at client level
// as they do not expose on ping listener 
// look for browser client side implementation at the bottom
// `Handle App Level Ping In Browser (example)`
wsServer.startAutoPing(10000, true);

停止服务器使用 close 函数 :

wsServer.close(() => {
  // triggered after server has been stopped
})

handleUpgrade 和 noServer (与 ws 模块)

const wss = new WebSocket.Server({ noServer: true });
const server = http.createServer();

wss.on('connection', (ws, req) => { })

server.on('upgrade', (request, socket, head) => {
  wss.handleUpgrade(request, socket, head, (ws) => {
      wss.emit('connection', ws, request);
  });
});

更多信息检查打字(*.d.ts文件在 数字 文件夹

安全 WebSocket 软件

你用得着 wss:// 与 cws 通过提供 https 服务器到 cws 设置 secureProtocol https 选项:

const { readFileSync } = require('fs');
const { createServer }  = require('https');
const { WebSocket, secureProtocol  } = require('@clusterws/cws');

const options = {
  key: readFileSync(/** path to key */),
  cert: readFileSync(/** path to certificate */),
  secureProtocol
  // ...other Node HTTPS options
};

const server = createServer(options);
const wsServer = new WebSocket.Server({ server });
// your secure ws is ready (do your usual things)

server.listen(port, () => {
  console.log('Server is running');
})

更详细的例子检查 实例 文件夹

在浏览器中处理 App Level Ping (例)

处理自定义 App 级别 ping, (中文(简体) ), pong 客户端没有 onping 财务报告和审定财务报表 onpong 浏览器等可用的收听器 .

说明 如果你所有的客户都有 onping 财务报告和审定财务报表 onpong 听众不发送 appLevelPing 从服务器接来 如果您启用了 ApplevelPing, 您需要为连接到服务器的每个客户端库执行类似的处理器 .

const PING = 57;
const PONG = new Uint8Array(['A'.charCodeAt()]);

socket.binaryType = 'arraybuffer';

socket.onmessage = function (message) {
    // note actually sent message in
    // browser default WebSocket is under `message.data`

    // check if message is not string 
    if (typeof message.data !== 'string') {
        // transform it to Uint8Array
        let buffer = new Uint8Array(message.data);

        // Check if it is actually ping from the server
        if (buffer.length === 1 && buffer[0] === PING) {
            // this is definitely `ping` event you can call custom on ping handler 
            // also must send back immediately pong to the server 
            // otherwise server will disconnect this client
            return socket.send(PONG);
        }
    }

    // process with your logic
}