Module module de base

Module ws

module de support websocket

Instructions:

1
var ws = require('ws');

Créez un serveur:

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

Utilisez le client WebSocket :

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

Objet

Message

Créer un objet de message websocket, voir WebSocketMessage

1
WebSocketMessage ws.Message;

Socket

Objet WebSocket , voir WebSocket

1
WebSocket ws.Socket;

Fonction statique

upgrade

Créez un processeur de protocole websocket, recevez une demande de mise à niveau de http et serrez la main, et générez un objet WebSocket

1
static Handler ws.upgrade(Function accept);

Paramètres d'appel:

  • accept : Fonction, la fonction de traitement du succès de la connexion, le rappel passera deux paramètres, le premier paramètre est l'objet WebSocket reçu et le deuxième paramètre est l'objet HttpRequest pendant la prise de contact

Résultat de retour:


Créez un processeur de protocole websocket, recevez une demande de mise à niveau de http et serrez la main, et générez un objet WebSocket

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

Paramètres d'appel:

  • opts : Objet, options de connexion, la valeur par défaut est {}
  • accept : Fonction, la fonction de traitement du succès de la connexion, le rappel passera deux paramètres, le premier paramètre est l'objet WebSocket reçu et le deuxième paramètre est l'objet HttpRequest pendant la prise de contact

Résultat de retour:

opts contient des options supplémentaires demandées et le contenu pris en charge est le suivant:

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

constant

CONTINUE

Spécifiez le type de message websocket 0, qui représente une trame de continuation

1
const ws.CONTINUE = 0;

TEXT

Spécifiez le type de message websocket 1, qui représente un cadre de texte

1
const ws.TEXT = 1;

BINARY

Spécifiez le type de message websocket 2, qui représente un cadre binaire

1
const ws.BINARY = 2;

CLOSE

Spécifiez le type de message websocket 8, la connexion est fermée

1
const ws.CLOSE = 8;

PING

Spécifiez le type de message Websocket 9, qui représente une trame ping

1
const ws.PING = 9;

PONG

Spécifiez le type de message websocket 10, qui représente une trame pong

1
const ws.PONG = 10;

CONNECTING

Spécifiez l'état de WebSocket , indiquant qu'il se connecte

1
const ws.CONNECTING = 0;

OPEN

Spécifiez l'état WebSocket , ce qui signifie l'état ouvert

1
const ws.OPEN = 1;

CLOSING

Spécifiez l'état de WebSocket , indiquant que le message CLOSE a été envoyé, en attente de fermeture

1
const ws.CLOSING = 2;

CLOSED

Spécifiez l'état de WebSocket , indiquant qu'il a été fermé

1
const ws.CLOSED = 3;