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éez un objet de message websocket, voir WebSocketMessage

1
WebSocketMessage ws.Message;

Socket

Objet WebSocket , voir WebSocket

1
WebSocket ws.Socket;

Fonction statique

upgrade

Créer un processeur de protocole websocket, recevoir une demande de mise à niveau de http et se serrer la main, générer un objet WebSocket

1
static Handler ws.upgrade(Function accept);

Paramètres d'appel:

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

Résultat de retour:


Créer un processeur de protocole websocket, recevoir une demande de mise à niveau de http et se serrer la main, générer 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 connexion est traitée avec succès, le rappel passera deux paramètres, le premier paramètre est l'objet WebSocket reçu, 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, 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, représentant une trame continue

1
const ws.CONTINUE = 0;

TEXT

Spécifiez le type de message Websocket 1, représentant un cadre de texte

1
const ws.TEXT = 1;

BINARY

Spécifiez le type de message Websocket 2, représentant une trame 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, représentant une trame pong

1
const ws.PONG = 10;

CONNECTING

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

1
const ws.CONNECTING = 0;

OPEN

Spécifiez l'état WebSocket , indiquant l'état ouvert

1
const ws.OPEN = 1;

CLOSING

Spécifiez le statut WebSocket , indiquant qu'un message CLOSE a été envoyé, en attente de fermeture

1
const ws.CLOSING = 2;

CLOSED

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

1
const ws.CLOSED = 3;