Módulo base del módulo

Módulo ws

módulo de soporte websocket

Cómo utilizar:

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();

Usando WebSocket Client:

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 controlador de protocolo websocket, reciba una solicitud de actualización de http y estreche la mano para generar un objeto WebSocket

1
static Handler ws.upgrade(Function accept);

Parámetros de llamada:

  • accept : Función, conexión exitosa función de procesamiento

Devuelve el resultado:

Cuando se llama a la función de aceptación, se pasan 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.

Constante

CONTINUE

Especifique el tipo de mensaje websocket 0, que representa un marco continuo

1
const ws.CONTINUE = 0;

TEXT

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

1
const ws.TEXT = 1;

BINARY

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

1
const ws.BINARY = 2;

CLOSE

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

1
const ws.CLOSE = 8;

PING

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

1
const ws.PING = 9;

PONG

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

1
const ws.PONG = 10;

CONNECTING

Especifique el estado de WebSocket , lo que indica que se está conectando

1
const ws.CONNECTING = 0;

OPEN

Especifique el estado de WebSocket , que indica el estado abierto

1
const ws.OPEN = 1;

CLOSING

Especifique el estado de WebSocket , lo que significa que se ha enviado un mensaje CERRAR, esperando ser cerrado

1
const ws.CLOSING = 2;

CLOSED

Especifique el estado de WebSocket , lo que significa que se ha cerrado

1
const ws.CLOSED = 3;