Módulo módulo básico

Módulo ws

módulo de soporte websocket

Instrucciones:

1
var ws = require('ws');

Crea un servidor:

1 2 3 4 5 6 7 8 9
var ws = require('ws'); var http = require('http'); var svr = new http.Server(80, { '/ws': ws.upgrade((conn, req) => { conn.onmessage = e => console.log(e.data); }) }); svr.run();

Utilice el cliente WebSocket :

1 2 3 4
var ws = require('ws'); var conn = new ws.Socket('ws://127.0.0.1/ws'); conn.onmessage = e => console.log(e.data);

Objeto

Message

Cree un objeto de mensaje websocket, consulte WebSocketMessage

1
WebSocketMessage ws.Message;

Socket

Objeto WebSocket , consulte WebSocket

1
WebSocket ws.Socket;

Función estática

upgrade

Cree un procesador de protocolo websocket, reciba una solicitud de actualización de http y dé la mano, y genere un objeto WebSocket

1
static Handler ws.upgrade(Function accept);

Parámetros de llamada:

  • accept : función, la función de procesamiento de éxito de la conexión, la devolución de llamada pasará dos parámetros, el primer parámetro es el objeto WebSocket recibido y el segundo parámetro es el objeto HttpRequest durante el protocolo de enlace

Devolver resultado:


Cree un procesador de protocolo websocket, reciba una solicitud de actualización de http y dé la mano, y genere un objeto WebSocket

1 2
static Handler ws.upgrade(Object opts, Function accept);

Parámetros de llamada:

  • opts : objeto, opciones de conexión, el valor predeterminado es {}
  • accept : función, la función de procesamiento de éxito de la conexión, la devolución de llamada pasará dos parámetros, el primer parámetro es el objeto WebSocket recibido y el segundo parámetro es el objeto HttpRequest durante el protocolo de enlace

Devolver resultado:

opts contiene opciones adicionales solicitadas, y el contenido admitido es el siguiente:

1 2 3 4
{ "perMessageDeflate": true, // 指定是否支持压缩,缺省支持 "maxPayload": 67108864 // 指定最大数据包尺寸,缺省为 67108864 }

constante

CONTINUE

Especifique el tipo de mensaje de websocket 0, que representa un marco de continuación

1
const ws.CONTINUE = 0;

TEXT

Especifique el tipo de mensaje 1 de websocket, que representa un marco de texto

1
const ws.TEXT = 1;

BINARY

Especifique el tipo de mensaje 2 de websocket, que representa un marco binario

1
const ws.BINARY = 2;

CLOSE

Especifique el tipo de mensaje de websocket 8, la conexión está cerrada

1
const ws.CLOSE = 8;

PING

Especifique el tipo de mensaje de websocket 9, que representa un marco de ping

1
const ws.PING = 9;

PONG

Especifique el tipo de mensaje de websocket 10, que representa un marco pong

1
const ws.PONG = 10;

CONNECTING

Especifique el estado de WebSocket , indicando que se está conectando

1
const ws.CONNECTING = 0;

OPEN

Especifique el estado de WebSocket , que significa estado abierto

1
const ws.OPEN = 1;

CLOSING

Especifique el estado de WebSocket , indicando que el mensaje CLOSE ha sido enviado, esperando ser cerrado

1
const ws.CLOSING = 2;

CLOSED

Especifique el estado de WebSocket , indicando que se ha cerrado

1
const ws.CLOSED = 3;