Mòdul mòdul bàsic

Mòdul ws

mòdul de suport de websocket

Instruccions:

1
var ws = require('ws');

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

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

Objecte

Message

Creeu un objecte de missatge de websocket, vegeu WebSocketMessage

1
WebSocketMessage ws.Message;

Socket

WebSocket Objecte, vegeu WebSocket

1
WebSocket ws.Socket;

Funció estàtica

upgrade

Creeu un gestor de protocols de websocket des de http Rep la sol·licitud d’actualització i dóna la mà, genera WebSocket Objecte

1
static Handler ws.upgrade(Function accept);

Paràmetres de trucada:

  • accept: Funció, la funció per gestionar la connexió amb èxit, la devolució de trucada passarà dos paràmetres, el primer paràmetre és el rebut WebSocket Objecte, el segon paràmetre és l’enfonsament de mans HttpRequest Objecte

Resultat de retorn:


Creeu un gestor de protocols de websocket des de http Rep la sol·licitud d’actualització i dóna la mà, genera WebSocket Objecte

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

Paràmetres de trucada:

  • opts: Objecte, opció de connexió, per defecte és {}
  • accept: Funció, la funció per gestionar la connexió amb èxit, la devolució de trucada passarà dos paràmetres, el primer paràmetre és el rebut WebSocket Objecte, el segon paràmetre és l’enfonsament de mans HttpRequest Objecte

Resultat de retorn:

opts conté opcions addicionals sol·licitades i el contingut admès és el següent:

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

constant

CONTINUE

Especifiqueu el tipus de missatge 0 de connexió web, que representa un marc de continuació

1
const ws.CONTINUE = 0;

TEXT

Especifiqueu el tipus de missatge de port de xarxa 1, que representa un marc de text

1
const ws.TEXT = 1;

BINARY

Especifiqueu el tipus de missatge de port de xarxa 2, que representa un marc binari

1
const ws.BINARY = 2;

CLOSE

Especifiqueu el tipus de missatge de port de xarxa 8, la connexió està tancada

1
const ws.CLOSE = 8;

PING

Especifiqueu el tipus de missatge de port de xarxa 9, que representa un marc de ping

1
const ws.PING = 9;

PONG

Especifiqueu el tipus de missatge 10 de connexió web, que representa un marc de taula

1
const ws.PONG = 10;

CONNECTING

Especificar WebSocket Estat, que indica que s'està connectant

1
const ws.CONNECTING = 0;

OPEN

Especificar WebSocket Estat, que significa estat obert

1
const ws.OPEN = 1;

CLOSING

Especificar WebSocket Estat, que indica que s’ha enviat el missatge TANCAR, esperant que es tanqui

1
const ws.CLOSING = 2;

CLOSED

Especificar WebSocket Estat, que vol dir que està tancat

1
const ws.CLOSED = 3;