オブジェクト組み込みオブジェクト

オブジェクトWebSocketMessage

websocketメッセージオブジェクト

作成方法:

1 2 3
var ws = require("ws"); var msg = new ws.Message();

継承

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>Message|new Message()|TEXT;BINARY|value;params;type;data;body;length;stream;lastError|read();readAll();write();json();pack();end();isEnded();clear();sendTo();readFrom()] [<this>WebSocketMessage|new WebSocketMessage()|masked;compress;maxSize] [object] <:- [Message] [Message] <:- [WebSocketMessage] Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() WebSocketMessage new WebSocketMessage() masked compress maxSize object toString() toJSON()

コンストラクタ

WebSocketMessage

パッケージ処理メッセージオブジェクトコンストラクター

1 2 3 4
new WebSocketMessage(Integer type = ws.BINARY, Boolean masked = true, Boolean compress = false, Integer maxSize = 67108864);

呼び出しパラメーター:

  • type:整数、websocketメッセージタイプ。デフォルトはwebsocket.BINARYです。
  • masked:ブール値、WebSocketメッセージマスク、デフォルトはtrue
  • compress:ブール値、メッセージが圧縮されているかどうかをマークします。デフォルトはfalseです。
  • maxSize:整数、最大パッケージサイズ、MB単位、デフォルトは67108864(64M)

絶え間ない

TEXT

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

1
const WebSocketMessage.TEXT = 1;

BINARY

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

1
const WebSocketMessage.BINARY = 2;

メンバー属性

masked

ブール値、クエリ、およびWebSocketマスクマークの読み取り。デフォルトはtrueです。

1
Boolean WebSocketMessage.masked;

compress

ブール値、クエリおよび読み取りWebSocket圧縮ステータス、デフォルトはfalse

1
Boolean WebSocketMessage.compress;

maxSize

整数、クエリ、および最大パケットサイズの設定(バイト単位)。デフォルトは67108864(64M)です。

1
Integer WebSocketMessage.maxSize;

value

文字列、メッセージの基本的な内容

1
String WebSocketMessage.value;

params

NArray、メッセージの基本パラメータ

1
readonly NArray WebSocketMessage.params;

type

整数、メッセージタイプ

1
Integer WebSocketMessage.type;

data

値、メッセージのデータを照会します。この属性は、コンテンツタイプに応じて異なるデータを返します。テキストの場合は、テキストを返します。 json 帰るとき json、その他の場合はバイナリに戻ります

1
readonly Value WebSocketMessage.data;

body

SeekableStream、メッセージのデータ部分を含むストリームオブジェクト

1
SeekableStream WebSocketMessage.body;

length

長い、メッセージのデータ部分の長さ

1
readonly Long WebSocketMessage.length;

stream

Stream、メッセージreadFrom時にストリームオブジェクトをクエリします

1
readonly Stream WebSocketMessage.stream;

lastError

メッセージ処理の最後のエラーを文字列、クエリ、および設定します

1
String WebSocketMessage.lastError;

メンバー関数

read

ストリームから指定されたサイズのデータ​​を読み取ります。このメソッドは、対応する本体のメソッドのエイリアスです。

1
Buffer WebSocketMessage.read(Integer bytes = -1) async;

呼び出しパラメーター:

  • bytes:整数、読み取るデータの量を指定します。デフォルトではランダムサイズのデータ​​ブロックを読み取ります。読み取られるデータのサイズはデバイスによって異なります。

戻り結果:

  • Buffer、ストリームから読み取ったデータを返します。読み取るデータがない場合、または接続が中断された場合は、nullを返します。

readAll

ストリームから残りのすべてのデータを読み取ります。このメソッドは、対応する本文のメソッドのエイリアスです。

1
Buffer WebSocketMessage.readAll() async;

戻り結果:

  • Buffer、ストリームから読み取ったデータを返します。読み取るデータがない場合、または接続が中断された場合は、nullを返します。

write

指定されたデータを書き込みます。このメソッドは、対応する本体のメソッドのエイリアスです。

1
WebSocketMessage.write(Buffer data) async;

呼び出しパラメーター:

  • dataBuffer、書き込まれるデータが与えられた場合

json

指定されたデータをJSONエンコーディングで書き込みます

1
Value WebSocketMessage.json(Value data);

呼び出しパラメーター:

  • data:書き込まれるデータが与えられた場合の値

戻り結果:

  • Value、このメソッドはデータを返しません

JSONエンコーディングでメッセージ内のデータを解析します

1
Value WebSocketMessage.json();

戻り結果:

  • Value、解析結果を返します

pack

msgpack 指定されたデータを書き込むためにエンコードします

1
Value WebSocketMessage.pack(Value data);

呼び出しパラメーター:

  • data:書き込まれるデータが与えられた場合の値

戻り結果:

  • Value、このメソッドはデータを返しません

msgpack メッセージ内のデータのエンコードと解析

1
Value WebSocketMessage.pack();

戻り結果:

  • Value、解析結果を返します

end

現在のメッセージ処理の終了を設定し、Chain プロセッサは後続のトランザクションを続行しません

1
WebSocketMessage.end();

isEnded

現在のメッセージが終了したかどうかを照会します

1
Boolean WebSocketMessage.isEnded();

戻り結果:

  • Boolean、最後にtrueを返します

clear

メッセージの内容をクリアする

1
WebSocketMessage.clear();

sendTo

指定されたストリームオブジェクトにフォーマットされたメッセージを送信します

1
WebSocketMessage.sendTo(Stream stm) async;

呼び出しパラメーター:

  • stmStream、フォーマットされたメッセージを受信するストリームオブジェクトを指定します

readFrom

指定されたキャッシュストリームオブジェクトからフォーマットされたメッセージを読み取り、充填オブジェクトを解析します

1
WebSocketMessage.readFrom(Stream stm) async;

呼び出しパラメーター:

  • stmStream、フォーマットされたメッセージを読み取るためのストリームオブジェクトを指定します

toString

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

1
String WebSocketMessage.toString();

戻り結果:

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

toJSON

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

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

呼び出しパラメーター:

  • key:文字列、未使用

戻り結果:

  • Value、シリアル化可能なJSONを含む値を返します