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