オブジェクトHttpMessage
http 基本的なメッセージオブジェクト
継承
絶え間ない
TEXT
テキストタイプを表すメッセージタイプ1を指定します
1const HttpMessage.TEXT = 1;
BINARY
バイナリタイプを表すメッセージタイプ2を指定します
1const HttpMessage.BINARY = 2;
メンバー属性
protocol
文字列、プロトコルバージョン情報、許可される形式は次のとおりです:HTTP /#。#
1String HttpMessage.protocol;
headers
HttpCollection、メッセージに含まれています http メッセージヘッダーのコンテナ、読み取り専用属性
1readonly HttpCollection HttpMessage.headers;
keepAlive
ブール値、クエリ、および接続を維持するかどうかの設定
1Boolean HttpMessage.keepAlive;
upgrade
ブール値、クエリ、およびアップグレード契約かどうかの設定
1Boolean HttpMessage.upgrade;
maxHeadersCount
整数、クエリ、およびリクエストヘッダーの最大数の設定。デフォルトは128です。
1Integer HttpMessage.maxHeadersCount;
maxBodySize
整数、クエリ、および本文の最大サイズの設定(MB単位)。デフォルトは64です。
1Integer HttpMessage.maxBodySize;
socket
Stream、現在のオブジェクトのソースソケットを照会します
1readonly Stream HttpMessage.socket;
value
文字列、メッセージの基本的な内容
1String HttpMessage.value;
params
NArray、メッセージの基本パラメータ
1readonly NArray HttpMessage.params;
type
整数、メッセージタイプ
1Integer HttpMessage.type;
data
値、メッセージのデータを照会します。この属性は、コンテンツタイプに応じて異なるデータを返します。テキストの場合は、テキストを返します。 json 帰るとき json、その他の場合はバイナリに戻ります
1readonly Value HttpMessage.data;
body
SeekableStream、メッセージのデータ部分を含むストリームオブジェクト
1SeekableStream HttpMessage.body;
length
長い、メッセージのデータ部分の長さ
1readonly Long HttpMessage.length;
stream
Stream、メッセージreadFrom時にストリームオブジェクトをクエリします
1readonly Stream HttpMessage.stream;
lastError
メッセージ処理の最後のエラーを文字列、クエリ、および設定します
1String HttpMessage.lastError;
メンバー関数
hasHeader
指定されたキー値を持つメッセージヘッダーがあるかどうかを確認します
1Boolean HttpMessage.hasHeader(String name);
呼び出しパラメーター:
- name:文字列、チェックするキー値を指定します
戻り結果:
- Boolean、キー値が存在するかどうかを返します
firstHeader
指定されたキー値の最初のメッセージヘッダーをクエリします
1String HttpMessage.firstHeader(String name);
呼び出しパラメーター:
- name:文字列、照会するキー値を指定します
戻り結果:
- String、キー値に対応する値を返します。存在しない場合は、未定義を返します。
allHeader
指定されたキー値のすべてのメッセージヘッダーをクエリします
1NObject HttpMessage.allHeader(String name = "");
呼び出しパラメーター:
- name:文字列、クエリするキー値を指定し、空の文字列を渡してすべてのキー値の結果を返します
戻り結果:
- NObject、キー値に対応するすべての値の配列を返します。データが存在しない場合は、nullを返します。
addHeader
メッセージヘッダーを追加します。データを追加しても、既存のキー値のメッセージヘッダーは変更されません。
1HttpMessage.addHeader(Object map);
呼び出しパラメーター:
- map:オブジェクト、追加するKey-Valueデータディクショナリを指定します
指定された名前のメッセージヘッダーのセットを追加します。データを追加しても、既存のキー値のメッセージヘッダーは変更されません。
1
2HttpMessage.addHeader(String name,
Array values);
呼び出しパラメーター:
- name:文字列、追加するキー値を指定します
- values:配列、追加するデータのセットを指定します
メッセージヘッダーを追加します。データを追加しても、既存のキー値のメッセージヘッダーは変更されません。
1
2HttpMessage.addHeader(String name,
String value);
呼び出しパラメーター:
- name:文字列、追加するキー値を指定します
- value:文字列、追加するデータを指定します
setHeader
メッセージヘッダーを設定します。データを設定すると、キー値に対応する最初の値が変更され、残りのメッセージヘッダーが同じキー値でクリアされます。
1HttpMessage.setHeader(Object map);
呼び出しパラメーター:
- map:オブジェクト、設定するKey-Valueデータディクショナリを指定します
指定された名前でメッセージヘッダーのセットを設定します。設定データはキー値に対応する値を変更し、同じキー値で残りのメッセージヘッダーをクリアします
1
2HttpMessage.setHeader(String name,
Array values);
呼び出しパラメーター:
- name:文字列、設定するキー値を指定します
- values:配列、設定するデータのセットを指定します
メッセージヘッダーを設定します。データを設定すると、キー値に対応する最初の値が変更され、残りのメッセージヘッダーが同じキー値でクリアされます。
1
2HttpMessage.setHeader(String name,
String value);
呼び出しパラメーター:
- name:文字列、設定するキー値を指定します
- value:文字列、設定するデータを指定します
removeHeader
指定されたキー値のすべてのメッセージヘッダーを削除します
1HttpMessage.removeHeader(String name);
呼び出しパラメーター:
- name:文字列、削除するキー値を指定します
read
ストリームから指定されたサイズのデータを読み取ります。このメソッドは、対応する本体のメソッドのエイリアスです。
1Buffer HttpMessage.read(Integer bytes = -1) async;
呼び出しパラメーター:
- bytes:整数、読み取るデータの量を指定します。デフォルトではランダムサイズのデータブロックを読み取ります。読み取られるデータのサイズはデバイスによって異なります。
戻り結果:
- Buffer、ストリームから読み取ったデータを返します。読み取るデータがない場合、または接続が中断された場合は、nullを返します。
readAll
ストリームから残りのすべてのデータを読み取ります。このメソッドは、対応する本文のメソッドのエイリアスです。
1Buffer HttpMessage.readAll() async;
戻り結果:
- Buffer、ストリームから読み取ったデータを返します。読み取るデータがない場合、または接続が中断された場合は、nullを返します。
write
指定されたデータを書き込みます。このメソッドは、対応する本体のメソッドのエイリアスです。
1HttpMessage.write(Buffer data) async;
呼び出しパラメーター:
- data: Buffer、書き込まれるデータが与えられた場合
json
指定されたデータをJSONエンコーディングで書き込みます
1Value HttpMessage.json(Value data);
呼び出しパラメーター:
- data:書き込まれるデータが与えられた場合の値
戻り結果:
- Value、このメソッドはデータを返しません
JSONエンコーディングでメッセージ内のデータを解析します
1Value HttpMessage.json();
戻り結果:
- Value、解析結果を返します
pack
に msgpack 指定されたデータを書き込むためにエンコードします
1Value HttpMessage.pack(Value data);
呼び出しパラメーター:
- data:書き込まれるデータが与えられた場合の値
戻り結果:
- Value、このメソッドはデータを返しません
に msgpack メッセージ内のデータのエンコードと解析
1Value HttpMessage.pack();
戻り結果:
- Value、解析結果を返します
end
現在のメッセージ処理の終了を設定し、Chain プロセッサは後続のトランザクションを続行しません
1HttpMessage.end();
isEnded
現在のメッセージが終了したかどうかを照会します
1Boolean HttpMessage.isEnded();
戻り結果:
- Boolean、最後にtrueを返します
clear
メッセージの内容をクリアする
1HttpMessage.clear();
sendTo
指定されたストリームオブジェクトにフォーマットされたメッセージを送信します
1HttpMessage.sendTo(Stream stm) async;
呼び出しパラメーター:
- stm: Stream、フォーマットされたメッセージを受信するストリームオブジェクトを指定します
readFrom
指定されたキャッシュストリームオブジェクトからフォーマットされたメッセージを読み取り、充填オブジェクトを解析します
1HttpMessage.readFrom(Stream stm) async;
呼び出しパラメーター:
- stm: Stream、フォーマットされたメッセージを読み取るためのストリームオブジェクトを指定します
toString
オブジェクトの文字列表現を返します。通常は「[NativeObject]」を返します。オブジェクトは、独自の特性に従って再実装できます。
1String HttpMessage.toString();
戻り結果:
- String、オブジェクトの文字列表現を返します
toJSON
オブジェクトのJSON形式の表現を返します。通常、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。
1Value HttpMessage.toJSON(String key = "");
呼び出しパラメーター:
- key:文字列、未使用
戻り結果:
- Value、シリアル化可能なJSONを含む値を返します