オブジェクトメッセージ
基本的なメッセージオブジェクト
メッセージオブジェクトはと互換性があります mq 各モジュールを使用して、カスタムメッセージ処理システムを構築し、メソッドを作成できます。
1
2var mq = require("mq");
var m = new mq.Message();
継承
コンストラクタ
Message
メッセージオブジェクトコンストラクタ
1new Message();
絶え間ない
TEXT
テキストタイプを表すメッセージタイプ1を指定します
1const Message.TEXT = 1;
BINARY
バイナリタイプを表すメッセージタイプ2を指定します
1const Message.BINARY = 2;
メンバー属性
value
文字列、メッセージの基本的な内容
1String Message.value;
params
NArray、メッセージの基本パラメータ
1readonly NArray Message.params;
type
整数、メッセージタイプ
1Integer Message.type;
data
値、メッセージのデータを照会します。この属性は、コンテンツタイプに応じて異なるデータを返します。テキストの場合は、テキストを返します。 json 帰るとき json、その他の場合はバイナリに戻ります
1readonly Value Message.data;
body
SeekableStream、メッセージのデータ部分を含むストリームオブジェクト
1SeekableStream Message.body;
length
長い、メッセージのデータ部分の長さ
1readonly Long Message.length;
stream
Stream、メッセージreadFrom時にストリームオブジェクトをクエリします
1readonly Stream Message.stream;
lastError
メッセージ処理の最後のエラーを文字列、クエリ、および設定します
1String Message.lastError;
メンバー関数
read
ストリームから指定されたサイズのデータを読み取ります。このメソッドは、対応する本体のメソッドのエイリアスです。
1Buffer Message.read(Integer bytes = -1) async;
呼び出しパラメーター:
- bytes:整数、読み取るデータの量を指定します。デフォルトではランダムサイズのデータブロックを読み取ります。読み取られるデータのサイズはデバイスによって異なります。
戻り結果:
- Buffer、ストリームから読み取ったデータを返します。読み取るデータがない場合、または接続が中断された場合は、nullを返します。
readAll
ストリームから残りのすべてのデータを読み取ります。このメソッドは、対応する本文のメソッドのエイリアスです。
1Buffer Message.readAll() async;
戻り結果:
- Buffer、ストリームから読み取ったデータを返します。読み取るデータがない場合、または接続が中断された場合は、nullを返します。
write
指定されたデータを書き込みます。このメソッドは、対応する本体のメソッドのエイリアスです。
1Message.write(Buffer data) async;
呼び出しパラメーター:
- data: Buffer、書き込まれるデータが与えられた場合
json
指定されたデータをJSONエンコーディングで書き込みます
1Value Message.json(Value data);
呼び出しパラメーター:
- data:書き込まれるデータが与えられた場合の値
戻り結果:
- Value、このメソッドはデータを返しません
JSONエンコーディングでメッセージ内のデータを解析します
1Value Message.json();
戻り結果:
- Value、解析結果を返します
pack
に msgpack 指定されたデータを書き込むためにエンコードします
1Value Message.pack(Value data);
呼び出しパラメーター:
- data:書き込まれるデータが与えられた場合の値
戻り結果:
- Value、このメソッドはデータを返しません
に msgpack メッセージ内のデータのエンコードと解析
1Value Message.pack();
戻り結果:
- Value、解析結果を返します
end
現在のメッセージ処理の終了を設定し、Chain プロセッサは後続のトランザクションを続行しません
1Message.end();
isEnded
現在のメッセージが終了したかどうかを照会します
1Boolean Message.isEnded();
戻り結果:
- Boolean、最後にtrueを返します
clear
メッセージの内容をクリアする
1Message.clear();
sendTo
指定されたストリームオブジェクトにフォーマットされたメッセージを送信します
1Message.sendTo(Stream stm) async;
呼び出しパラメーター:
- stm: Stream、フォーマットされたメッセージを受信するストリームオブジェクトを指定します
readFrom
指定されたキャッシュストリームオブジェクトからフォーマットされたメッセージを読み取り、充填オブジェクトを解析します
1Message.readFrom(Stream stm) async;
呼び出しパラメーター:
- stm: Stream、フォーマットされたメッセージを読み取るためのストリームオブジェクトを指定します
toString
オブジェクトの文字列表現を返します。通常は「[NativeObject]」を返します。オブジェクトは、独自の特性に従って再実装できます。
1String Message.toString();
戻り結果:
- String、オブジェクトの文字列表現を返します
toJSON
オブジェクトのJSON形式の表現を返します。通常、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。
1Value Message.toJSON(String key = "");
呼び出しパラメーター:
- key:文字列、未使用
戻り結果:
- Value、シリアル化可能なJSONを含む値を返します