Modulo modulo base

Modulo w

modulo di supporto websocket

Istruzioni:

1
var ws = require('ws');

Crea un server:

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 Cliente:

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

Oggetto

Message

Crea un oggetto messaggio websocket, vedi WebSocketMessage

1
WebSocketMessage ws.Message;

Socket

WebSocket Oggetto, vedi WebSocket

1
WebSocket ws.Socket;

Funzione statica

upgrade

Crea un gestore di protocollo websocket da http Ricevi la richiesta di aggiornamento e stringi la mano, genera WebSocket Oggetto

1
static Handler ws.upgrade(Function accept);

Parametri di chiamata:

  • accept: Funzione, la funzione per gestire la connessione riuscita, il callback passerà due parametri, il primo parametro è il ricevuto WebSocket Oggetto, il secondo parametro è la stretta di mano HttpRequest Oggetto

Risultato di ritorno:


Crea un gestore di protocollo websocket da http Ricevi la richiesta di aggiornamento e stringi la mano, genera WebSocket Oggetto

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

Parametri di chiamata:

  • opts: Oggetto, opzione di connessione, il valore predefinito è {}
  • accept: Funzione, la funzione per gestire la connessione riuscita, il callback passerà due parametri, il primo parametro è il ricevuto WebSocket Oggetto, il secondo parametro è la stretta di mano HttpRequest Oggetto

Risultato di ritorno:

opts contiene opzioni aggiuntive richieste e il contenuto supportato è il seguente:

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

costante

CONTINUE

Specificare il tipo di messaggio websocket 0, che rappresenta un frame di continuazione

1
const ws.CONTINUE = 0;

TEXT

Specificare il tipo di messaggio websocket 1, che rappresenta una cornice di testo

1
const ws.TEXT = 1;

BINARY

Specifica il tipo di messaggio 2 del websocket, che rappresenta un frame binario

1
const ws.BINARY = 2;

CLOSE

Specificare il tipo di messaggio websocket 8, la connessione è chiusa

1
const ws.CLOSE = 8;

PING

Specifica il tipo di messaggio websocket 9, che rappresenta un frame ping

1
const ws.PING = 9;

PONG

Specifica il tipo di messaggio websocket 10, che rappresenta un frame pong

1
const ws.PONG = 10;

CONNECTING

Specificare WebSocket Stato, che indica che si sta connettendo

1
const ws.CONNECTING = 0;

OPEN

Specificare WebSocket Stato, che significa stato aperto

1
const ws.OPEN = 1;

CLOSING

Specificare WebSocket Stato, che indica che è stato inviato il messaggio CLOSE, in attesa di essere chiuso

1
const ws.CLOSING = 2;

CLOSED

Specificare WebSocket Stato, che significa che è chiuso

1
const ws.CLOSED = 3;