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

モジュール 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.start();

使用する 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

websocket メッセージ オブジェクトを作成します。参照してください。 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 オブジェクト

結果を返す:

  • Handler、プロトコル ハンドラーに戻ります。これは、と共に使用できます。 HttpServerChainRouting ドッキングを待っています `

から websocket プロトコル ハンドラーを作成します。 http アップグレード依頼を受けて握手、生成 WebSocket オブジェクト

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

呼び出しパラメータ:

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

結果を返す:

  • Handler、プロトコル ハンドラーに戻ります。これは、と共に使用できます。 HttpServerChainRouting ドッキングを待っています

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

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

1
const ws.CLOSE = 8;

PING

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

1
const ws.PING = 9;

PONG

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;