Module module de base

Module ws

module de prise en charge des sockets Web

Instructions:

1
var ws = require('ws');

Créer 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.start();

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

Objet

Message

Créer un objet de message Websocket, voir WebSocketMessage

1
WebSocketMessage ws.Message;

Socket

WebSocket Objet, voir WebSocket

1
WebSocket ws.Socket;

Fonction statique

upgrade

Créer un gestionnaire de protocole Websocket à partir de http Recevez une demande de mise à niveau et serrez la main, générez WebSocket Objet

1
static Handler ws.upgrade(Function accept);

Paramètres d'appel :

  • accept: Fonction, la fonction pour gérer la connexion réussie, le rappel passera deux paramètres, le premier paramètre est le reçu WebSocket Objet, le deuxième paramètre est la poignée de main HttpRequest Objet

Résultat de retour :


Créer un gestionnaire de protocole Websocket à partir de http Recevez une demande de mise à niveau et serrez la main, générez WebSocket Objet

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

Paramètres d'appel :

  • opts: Objet, option de connexion, la valeur par défaut est {}
  • accept: Fonction, la fonction pour gérer la connexion réussie, le rappel passera deux paramètres, le premier paramètre est le reçu WebSocket Objet, le deuxième paramètre est la poignée de main HttpRequest Objet

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 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 de 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écifier WebSocket Statut, indiquant qu'il se connecte

1
const ws.CONNECTING = 0;

OPEN

Spécifier WebSocket État, ce qui signifie état ouvert

1
const ws.OPEN = 1;

CLOSING

Spécifier WebSocket Statut, indiquant que le message FERMETURE a été envoyé, en attente de fermeture

1
const ws.CLOSING = 2;

CLOSED

Spécifier WebSocket Statut, ce qui signifie qu'il est fermé

1
const ws.CLOSED = 3;