モジュール基本モジュール

モジュールws

websocketサポートモジュール

指示:

1
var ws = require('ws');

サーバーを作成します。

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

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

オブジェクト

Message

WebSocketMessageメッセージオブジェクトを作成します。WebSocketMessageを参照してください。

1
WebSocketMessage ws.Message;

Socket

WebSocketオブジェクト、参照WebSocket

1
WebSocket ws.Socket;

静的機能

upgrade

Websocketプロトコルプロセッサを作成し、 httpからアップグレード要求を受信して​​握手し、 WebSocketオブジェクトを生成します

1
static Handler ws.upgrade(Function accept);

呼び出しパラメーター:

  • accept :関数、接続成功処理関数、コールバックは2つのパラメーターを渡します。最初のパラメーターは、受信したWebSocketオブジェクトであり、2番目のパラメーターはハンドシェイク中のHttpRequestオブジェクトHttpRequest

戻り結果:

  • Handler 、プロトコルハンドラーは、 HttpServerChainRouting 、およびその他のドッキングを使用して戻ります`

Websocketプロトコルプロセッサを作成し、 httpからアップグレード要求を受信して​​握手し、 WebSocketオブジェクトを生成します

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

呼び出しパラメーター:

  • opts :オブジェクト、接続オプション、デフォルトは{}
  • accept :関数、接続成功処理関数、コールバックは2つのパラメーターを渡します。最初のパラメーターは、受信したWebSocketオブジェクトであり、2番目のパラメーターはハンドシェイク中のHttpRequestオブジェクトHttpRequest

戻り結果:

optsには、要求された追加オプションが含まれており、サポートされるコンテンツは次のとおりです。

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

絶え間ない

CONTINUE

継続フレームを表すwebsocketメッセージタイプ0を指定します

1
const ws.CONTINUE = 0;

TEXT

テキストフレームを表すwebsocketメッセージタイプ1を指定します

1
const ws.TEXT = 1;

BINARY

バイナリフレームを表すwebsocketメッセージタイプ2を指定します

1
const ws.BINARY = 2;

CLOSE

Webソケットメッセージタイプ8を指定すると、接続が閉じられます

1
const ws.CLOSE = 8;

PING

pingフレームを表すwebsocketメッセージタイプ9を指定します

1
const ws.PING = 9;

PONG

ポンフレームを表すwebsocketメッセージタイプ10を指定します

1
const ws.PONG = 10;

CONNECTING

接続中であることを示すWebSocketステータスを指定します

1
const ws.CONNECTING = 0;

OPEN

WebSocket状態を指定します。これは、開いた状態を意味します

1
const ws.OPEN = 1;

CLOSING

WebSocketステータスを指定します。これは、CLOSEメッセージが送信され、閉じられるのを待っていることを示します。

1
const ws.CLOSING = 2;

CLOSED

WebSocketステータスを指定して、閉じられたことを示します

1
const ws.CLOSED = 3;