オブジェクト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 ：文字列、ハンドシェイク中にシミュレートされた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
2
Object WebSocket.once(String ev,
    Function func);

呼び出しパラメーター：

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

戻り結果：

Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

ワンタイムイベント処理関数をオブジェクトにバインドします。ワンタイム処理関数は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(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

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

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