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

オブジェクト 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

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

1
readonly Long WebSocketMessage.length;

stream

Stream、メッセージがreadFromのときにストリームオブジェクトを照会します

1
readonly Stream WebSocketMessage.stream;

lastError

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

1
String WebSocketMessage.lastError;

メンバー関数

read

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

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

呼び出しパラメータ:

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

結果を返す:

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

readAll

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

1
Buffer WebSocketMessage.readAll() async;

結果を返す:

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

write

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

1
WebSocketMessage.write(Buffer data) async;

呼び出しパラメータ:

  • data: Buffer、書き込むデータが与えられると

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;

呼び出しパラメータ:

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

readFrom

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

1
WebSocketMessage.readFrom(Stream stm) async;

呼び出しパラメータ:

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

toString

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

1
String WebSocketMessage.toString();

結果を返す:

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

toJSON

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

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

呼び出しパラメータ:

  • key: ストリング、未使用

結果を返す:

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