オブジェクト WebSocket

WebSocket パケットプロトコル変換プロセッサ

これは、Http プロトコルを WebSocket パケットプロトコルメッセージに変換するために使用されます。作成方法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
var ws = require('ws');
var http = require('http');

var serv = new http.Server(8811, ws.upgrade((conn) => {
    conn.onmessage = msg => {
        conn.send(new Date());
    };
}));

serv.run(r => 0);

var sock = new ws.Socket('ws://127.0.0.1:8811');
sock.on('open', () => {
    setInterval(() => {
        sock.send('get date');
    }, 1000);
});

sock.onmessage = evt => {
    console.log(evt.data);
}

継承

コンストラクタ

WebSocket

WebSocket コンストラクター

1
2
3
new WebSocket(String url,
    String protocol = "",
    String origin = "");

呼び出しパラメータ:

url: 文字列、接続されたサーバーを指定します
protocol: 文字列、ハンドシェイクプロトコルを指定します。デフォルトは「」です
origin: 文字列、ハンドシェイク中にシミュレートするソースを指定します。デフォルトは「」です

WebSocket コンストラクター

1
2
new WebSocket(String url,
    Object opts);

呼び出しパラメータ:

url: 文字列、接続されたサーバーを指定します
opts: オブジェクト、接続オプション、デフォルトは {}

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

1
2
3
4
5
6
7
8{
    "protocol": "", // 指定握手协议，缺省为空
    "origin": "", // 指定握手时模拟的源，缺省为空
    "perMessageDeflate": true, // 指定是否支持压缩，缺省支持
    "maxPayload": 67108864, // 指定最大数据包尺寸，缺省为 67108864
    "httpClient": hc, // 自定义 httpClient 对象，缺省使用全局 httpClient
    "headers": // 指定 http(s) 连接时携带的 header，缺省为 {}，
}

静的プロパティ

defaultMaxListeners

整数、リスナーのデフォルトのグローバル最大数

1
static Integer WebSocket.defaultMaxListeners;

メンバーの属性

url

文字列、現在のオブジェクトに接続されているサーバーに問い合わせます

1
readonly String WebSocket.url;

protocol

文字列、現在のオブジェクトが接続されているときにプロトコルを照会します

1
readonly String WebSocket.protocol;

origin

文字列、現在のオブジェクト接続のソースを照会します

1
readonly String WebSocket.origin;

readyState

整数、現在のオブジェクトの接続ステータスを照会します。参照 ws

1readonly Integer WebSocket.readyState;

onopen

on("open", func); と同等の関数、クエリ、バインド接続成功イベント。

1
Function WebSocket.onopen;

onmessage

on("message", func); と同等で、相手からメッセージを受信するイベントを関数、クエリ、およびバインドします。

1
Function WebSocket.onmessage;

onclose

on("close", func); と同等の、接続クローズのイベントを関数、クエリ、およびバインドします。

1
Function WebSocket.onclose;

onerror

on("error", func); と同等の関数、クエリ、バインドエラーイベント。

1
Function WebSocket.onerror;

メンバー関数

close

現在の接続を閉じます。この操作により、CLOSE パケットが相手に送信され、相手が応答するのを待ちます。

1
2
WebSocket.close(Integer code = 1000,
    String reason = "");

呼び出しパラメータ:

code: 整数、閉じるコードを指定します。許容値は 3000 ～ 4999 または 1000 です。デフォルトは 1000 です。
reason: 文字列、閉鎖の理由を指定します。デフォルトは「」です

send

相手にテキストを送る

1
WebSocket.send(String data);

呼び出しパラメータ:

data: 文字列、送信するテキストを指定します

バイナリデータの一部を相手に送信する

1WebSocket.send(Buffer data);

呼び出しパラメータ:

data: Buffer、送信するバイナリデータを指定

ref

fibjs プロセスが終了しないようにし、オブジェクトバインド中に fibjs プロセスが終了しないようにする

1WebSocket WebSocket.ref();

結果を返す:

WebSocket、現在のオブジェクトを返します

unref

fibjs プロセスの終了を許可し、オブジェクトバインド中に fibjs プロセスを終了できるようにします。

1WebSocket WebSocket.unref();

結果を返す:

WebSocket、現在のオブジェクトを返します

on

イベントハンドラーをオブジェクトにバインドする

1
2
Object WebSocket.on(String ev,
    Function func);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定
func：関数、イベント処理関数を指定

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

イベントハンドラーをオブジェクトにバインドする

1
Object WebSocket.on(Object map);

呼び出しパラメータ:

map: オブジェクト、イベントマッピング関係を指定します。オブジェクトプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

addListener

イベントハンドラーをオブジェクトにバインドする

1
2
Object WebSocket.addListener(String ev,
    Function func);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定
func：関数、イベント処理関数を指定

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

イベントハンドラーをオブジェクトにバインドする

1
Object WebSocket.addListener(Object map);

呼び出しパラメータ:

map: オブジェクト、イベントマッピング関係を指定します。オブジェクトプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

prependListener

イベントハンドラーをオブジェクトの先頭にバインドします。

1
2
Object WebSocket.prependListener(String ev,
    Function func);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定
func：関数、イベント処理関数を指定

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

イベントハンドラーをオブジェクトの先頭にバインドします。

1
Object WebSocket.prependListener(Object map);

呼び出しパラメータ:

map: オブジェクト、イベントマッピング関係を指定します。オブジェクトプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

once

1 回限りのイベント処理関数をオブジェクトにバインドします。1 回限りの処理関数は 1 回だけトリガーされます。

1
2
Object WebSocket.once(String ev,
    Function func);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定
func：関数、イベント処理関数を指定

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

1 回限りのイベント処理関数をオブジェクトにバインドします。1 回限りの処理関数は 1 回だけトリガーされます。

1
Object WebSocket.once(Object map);

呼び出しパラメータ:

map: オブジェクト、イベントマッピング関係を指定します。オブジェクトプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

prependOnceListener

イベントハンドラーをオブジェクトの先頭にバインドします。

1
2
Object WebSocket.prependOnceListener(String ev,
    Function func);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定
func：関数、イベント処理関数を指定

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

イベントハンドラーをオブジェクトの先頭にバインドします。

1
Object WebSocket.prependOnceListener(Object map);

呼び出しパラメータ:

map: オブジェクト、イベントマッピング関係を指定します。オブジェクトプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

off

指定された関数をオブジェクト処理キューからキャンセルします

1
2
Object WebSocket.off(String ev,
    Function func);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定
func：関数、イベント処理関数を指定

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

オブジェクト処理キュー内のすべての機能をキャンセルします

1
Object WebSocket.off(String ev);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

指定された関数をオブジェクト処理キューからキャンセルします

1
Object WebSocket.off(Object map);

呼び出しパラメータ:

map: オブジェクト、イベントマッピング関係を指定します。オブジェクトプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

removeListener

指定された関数をオブジェクト処理キューからキャンセルします

1
2
Object WebSocket.removeListener(String ev,
    Function func);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定
func：関数、イベント処理関数を指定

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

オブジェクト処理キュー内のすべての機能をキャンセルします

1
Object WebSocket.removeListener(String ev);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

指定された関数をオブジェクト処理キューからキャンセルします

1
Object WebSocket.removeListener(Object map);

呼び出しパラメータ:

map: オブジェクト、イベントマッピング関係を指定します。オブジェクトプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

removeAllListeners

オブジェクト処理キューから全イベントの全リスナーを解除イベントを指定している場合は、指定したイベントの全リスナーを削除します。

1
Object WebSocket.removeAllListeners(String ev);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

オブジェクト処理キューから全イベントの全リスナーを解除イベントを指定している場合は、指定したイベントの全リスナーを削除します。

1
Object WebSocket.removeAllListeners(Array evs = []);

呼び出しパラメータ:

evs: 配列、イベントの名前を指定します

結果を返す:

Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

setMaxListeners

互換性のためだけのリスナー数のデフォルト制限

1WebSocket.setMaxListeners(Integer n);

呼び出しパラメータ:

n: 整数、イベント数を指定

getMaxListeners

互換性のためだけに、リスナーの数のデフォルトの制限を取得します

1Integer WebSocket.getMaxListeners();

結果を返す:

Integer, デフォルトの制限数に戻す

listeners

クエリオブジェクトの指定されたイベントのリスナーの配列

1
Array WebSocket.listeners(String ev);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定

結果を返す:

Array、指定されたイベントのリスナーの配列を返します

listenerCount

クエリオブジェクトの指定されたイベントのリスナーの数

1
Integer WebSocket.listenerCount(String ev);

呼び出しパラメータ:

ev: 文字列、イベントの名前を指定

結果を返す:

Integer、指定されたイベントのリスナーの数を返します

eventNames

リスナーのイベント名を問い合わせる

1
Array WebSocket.eventNames();

結果を返す:

Array、イベント名の配列を返します

emit

イベントを積極的にトリガーする

1
2
Boolean WebSocket.emit(String ev,
    ...args);

呼び出しパラメータ:

ev: 文字列、イベント名
args: ...、イベントハンドラーに渡されるイベントパラメーター

結果を返す:

Boolean、イベントトリガー状態に戻り、レスポンスイベントがあればtrue、そうでなければfalseを返す

toString

オブジェクトの文字列表現を返します。通常は「[ネイティブオブジェクト]」を返します。オブジェクトは独自の特性に従って再実装できます。

1
String WebSocket.toString();

結果を返す:

String、オブジェクトの文字列表現を返します

toJSON

オブジェクトの JSON 形式の表現を返します。通常は、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。

1
Value WebSocket.toJSON(String key = "");

呼び出しパラメータ:

key: ストリング、未使用

結果を返す:

Value、シリアライズ可能なJSONを含む値を返します

開発ガイド

基本モジュール

組み込みオブジェクト

コミュニティモジュール

オブジェクト WebSocket

継承

コンストラクタ

WebSocket

静的プロパティ

defaultMaxListeners

メンバーの属性

url

protocol

origin

readyState

onopen

onmessage

onclose

onerror

メンバー関数

close

send

ref

unref

on

addListener

prependListener

once

prependOnceListener

off

removeListener

removeAllListeners

setMaxListeners

getMaxListeners

listeners

listenerCount

eventNames

emit

toString

toJSON