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

モジュール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 物体

戻り結果:

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

1 2 3 4
{ "perMessageDeflate": false, // 指定是否支持压缩,缺省不支持 "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

ポンフレームを表す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;