Modul Basismodul

Modul ws

Websocket-Unterstützungsmodul

Anweisungen:

1
var ws = require('ws');

Erstellen Sie einen 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();

verwenden WebSocket Klient:

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

Objekt

Message

Erstellen Sie ein Websocket-Nachrichtenobjekt, siehe WebSocketMessage

1
WebSocketMessage ws.Message;

Socket

WebSocket Objekt, siehe WebSocket

1
WebSocket ws.Socket;

Statische Funktion

upgrade

Erstellen Sie einen Websocket-Protokollhandler aus http Upgrade-Anfrage erhalten und Hände schütteln, generieren WebSocket Objekt

1
static Handler ws.upgrade(Function accept);

Aufrufparameter:

  • accept: Funktion, die Funktion zum Behandeln der erfolgreichen Verbindung, der Rückruf übergibt zwei Parameter, der erste Parameter ist der empfangene WebSocket Objekt, der zweite Parameter ist der Handshake HttpRequest Objekt

Ergebnis zurückgeben:


Erstellen Sie einen Websocket-Protokollhandler aus http Upgrade-Anfrage erhalten und Hände schütteln, generieren WebSocket Objekt

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

Aufrufparameter:

  • opts: Objekt, Verbindungsoption, Standard ist {}
  • accept: Funktion, die Funktion zum Behandeln der erfolgreichen Verbindung, der Rückruf übergibt zwei Parameter, der erste Parameter ist der empfangene WebSocket Objekt, der zweite Parameter ist der Handshake HttpRequest Objekt

Ergebnis zurückgeben:

opts enthält zusätzliche angeforderte Optionen und der unterstützte Inhalt ist wie folgt:

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

Konstante

CONTINUE

Geben Sie den Websocket-Nachrichtentyp 0 an, der einen Fortsetzungsrahmen darstellt

1
const ws.CONTINUE = 0;

TEXT

Geben Sie den Websocket-Nachrichtentyp 1 an, der einen Textrahmen darstellt

1
const ws.TEXT = 1;

BINARY

Geben Sie den Websocket-Nachrichtentyp 2 an, der einen binären Frame darstellt

1
const ws.BINARY = 2;

CLOSE

Geben Sie den Websocket-Nachrichtentyp 8 an, die Verbindung wird geschlossen

1
const ws.CLOSE = 8;

PING

Geben Sie den Websocket-Nachrichtentyp 9 an, der einen Ping-Frame darstellt

1
const ws.PING = 9;

PONG

Geben Sie den Websocket-Nachrichtentyp 10 an, der einen Pong-Frame darstellt

1
const ws.PONG = 10;

CONNECTING

Angeben WebSocket Status, der anzeigt, dass eine Verbindung hergestellt wird

1
const ws.CONNECTING = 0;

OPEN

Angeben WebSocket Staat, was offener Staat bedeutet

1
const ws.OPEN = 1;

CLOSING

Angeben WebSocket Status, der anzeigt, dass die CLOSE-Nachricht gesendet wurde und darauf wartet, geschlossen zu werden

1
const ws.CLOSING = 2;

CLOSED

Angeben WebSocket Status, was bedeutet, dass es geschlossen ist

1
const ws.CLOSED = 3;