Módulo módulo básico

Módulo ws

módulo de soporte web

Instrucións:

1
var ws = require('ws');

Crear 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.start();

uso WebSocket Clienta:

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

Obxecto

Message

Crea un obxecto de mensaxe de portátil web, ver WebSocketMessage

1
WebSocketMessage ws.Message;

Socket

WebSocket Obxecto, ver WebSocket

1
WebSocket ws.Socket;

Función estática

upgrade

Crea un controlador de protocolo de websocket desde http Recibir solicitude de actualización e dar a man, xerar WebSocket Obxecto

1
static Handler ws.upgrade(Function accept);

Parámetros de chamada:

  • accept: Función, a función para xestionar a conexión correcta, a devolución de chamada pasará dous parámetros, o primeiro parámetro é o recibido WebSocket Obxecto, o segundo parámetro é o apretón de mans HttpRequest Obxecto

Resultado de volta:


Crea un controlador de protocolo de websocket desde http Recibir solicitude de actualización e dar a man, xerar WebSocket Obxecto

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

Parámetros de chamada:

  • opts: Obxecto, opción de conexión, o predeterminado é {}
  • accept: Función, a función para xestionar a conexión correcta, a devolución de chamada pasará dous parámetros, o primeiro parámetro é o recibido WebSocket Obxecto, o segundo parámetro é o apretón de mans HttpRequest Obxecto

Resultado de volta:

opts contén opcións adicionais solicitadas e o contido soportado é o seguinte:

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

constante

CONTINUE

Especifique o tipo de mensaxe de portafolio 0, que representa un marco de continuación

1
const ws.CONTINUE = 0;

TEXT

Especifique o tipo de mensaxe de portafolio 1, que representa un marco de texto

1
const ws.TEXT = 1;

BINARY

Especifique o tipo de mensaxe de portafolio 2, que representa un marco binario

1
const ws.BINARY = 2;

CLOSE

Especifique o tipo de mensaxe de portafolio 8, a conexión está pechada

1
const ws.CLOSE = 8;

PING

Especifique o tipo de mensaxe de portafolio 9, que representa un marco de ping

1
const ws.PING = 9;

PONG

Especifique o tipo de mensaxe de 10 portátiles web, que representa un marco de pong

1
const ws.PONG = 10;

CONNECTING

Especificar WebSocket Estado, que indica que se está conectando

1
const ws.CONNECTING = 0;

OPEN

Especificar WebSocket Estado, que significa estado aberto

1
const ws.OPEN = 1;

CLOSING

Especificar WebSocket Estado, que indica que se enviou a mensaxe PECHAR, á espera de ser pechado

1
const ws.CLOSING = 2;

CLOSED

Especificar WebSocket Estado, o que significa que está pechado

1
const ws.CLOSED = 3;