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

objectHttpRequest

httpリクエストメッセージオブジェクト

相続関係

#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()] [<class>HttpMessage|protocol;headers;keepAlive;upgrade;maxHeadersCount;maxBodySize;socket|hasHeader();firstHeader();allHeader();addHeader();setHeader();removeHeader()] [<this>HttpRequest|new HttpRequest()|response;method;address;queryString;cookies;form;query] [object] <:- [Message] [Message] <:- [HttpMessage] [HttpMessage] <:- [HttpRequest] Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() HttpMessage protocol headers keepAlive upgrade maxHeadersCount maxBodySize socket hasHeader() firstHeader() allHeader() addHeader() setHeader() removeHeader() HttpRequest new HttpRequest() response method address queryString cookies form query object toString() toJSON()

コンストラクタ

HttpRequest

新しい HttpRequest オブジェクトを作成する HttpRequest コンストラクター

1
new HttpRequest();

絶え間ない

TEXT

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

1
const HttpRequest.TEXT = 1;

BINARY

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

1
const HttpRequest.BINARY = 2;

メンバー プロパティ

response

HttpResponse、応答メッセージ オブジェクトを取得します

1
readonly HttpResponse HttpRequest.response;

method

文字列、クエリ、および設定リクエスト メソッド

1
String HttpRequest.method;

address

文字列、クエリ、リクエスト アドレスの設定

1
String HttpRequest.address;

queryString

文字列、クエリ、および設定リクエストのクエリ文字列

1
String HttpRequest.queryString;

cookies

HttpCollection、メッセージ Cookie を含むコンテナを取得します

1
readonly HttpCollection HttpRequest.cookies;

form

HttpCollection、メッセージフォームを含むコンテナーを取得します

1
readonly HttpCollection HttpRequest.form;

query

HttpCollection、メッセージ クエリを含むコンテナを取得します

1
readonly HttpCollection HttpRequest.query;

protocol

文字列、プロトコル バージョン情報、使用できる形式は次のとおりです: HTTP/#.#

1
String HttpRequest.protocol;

headers

HttpCollection、メッセージに含まれるhttpメッセージ ヘッダーのコンテナ、読み取り専用プロパティ

1
readonly HttpCollection HttpRequest.headers;

keepAlive

接続を維持するかどうかのブール値、クエリ、および設定

1
Boolean HttpRequest.keepAlive;

upgrade

アップグレード プロトコルかどうかのブール値、クエリ、および設定

1
Boolean HttpRequest.upgrade;

maxHeadersCount

リクエスト ヘッダーの最大数を整数でクエリおよび設定します。デフォルトは 128 です。

1
Integer HttpRequest.maxHeadersCount;

maxBodySize

本体の最大サイズを整数で照会および設定します。MB 単位で、デフォルトは 64 です。

1
Integer HttpRequest.maxBodySize;

socket

Stream、現在のオブジェクトのソース ソケットを照会します

1
readonly Stream HttpRequest.socket;

value

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

1
String HttpRequest.value;

params

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

1
readonly NArray HttpRequest.params;

type

整数、メッセージ タイプ

1
Integer HttpRequest.type;

data

値、メッセージのデータを照会します。このプロパティは、コンテンツ タイプに応じて異なるデータを返します。テキストの場合は、テキストを返します。jsonいつ戻るjson、それ以外の場合はバイナリを返します

1
readonly Value HttpRequest.data;

body

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

1
SeekableStream HttpRequest.body;

length

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

1
readonly Long HttpRequest.length;

stream

Stream、メッセージ readFrom をクエリするときのストリーム オブジェクト

1
readonly Stream HttpRequest.stream;

lastError

文字列、クエリおよびセット メッセージ処理の最後のエラー

1
String HttpRequest.lastError;

メンバー関数

hasHeader

指定されたキー値を持つメッセージ ヘッダーがあるかどうかを確認します

1
Boolean HttpRequest.hasHeader(String name);

呼び出しパラメーター:

  • name: 文字列、チェックするキー値を指定します

返される結果:

  • Boolean、キー値が存在するかどうかを返します

firstHeader

指定されたキー値の最初のメッセージ ヘッダーをクエリします

1
String HttpRequest.firstHeader(String name);

呼び出しパラメーター:

  • name: 文字列。クエリするキー値を指定します

返される結果:

  • String、キー値に対応する値を返すか、存在しない場合は undefined を返します

allHeader

指定されたキー値のすべてのメッセージ ヘッダーを照会します

1
NObject HttpRequest.allHeader(String name = "");

呼び出しパラメーター:

  • name: 文字列、照会するキー値を指定し、空の文字列を渡してすべてのキー値の結果を返します

返される結果:

  • NObject、キー値に対応するすべての値の配列、またはデータが存在しない場合は null を返します

addHeader

メッセージ ヘッダーを追加し、既存のキー値のメッセージ ヘッダーを変更せずにデータを追加します

1
HttpRequest.addHeader(Object map);

呼び出しパラメーター:

  • map: オブジェクト。追加するキーと値のデータ ディクショナリを指定します。

指定された名前で一連のメッセージ ヘッダーを追加し、既存のキー値のメッセージ ヘッダーを変更せずにデータを追加します

1 2
HttpRequest.addHeader(String name, Array values);

呼び出しパラメーター:

  • name: 文字列。追加するキー値を指定します
  • values: 配列、追加するデータのセットを指定します

メッセージ ヘッダーを追加し、既存のキー値のメッセージ ヘッダーを変更せずにデータを追加します

1 2
HttpRequest.addHeader(String name, String value);

呼び出しパラメーター:

  • name: 文字列。追加するキー値を指定します
  • value: 文字列、追加するデータを指定します

setHeader

メッセージ ヘッダーを設定します。設定データは、キー値に対応する最初の値を変更し、同じキー値の残りのメッセージ ヘッダーをクリアします。

1
HttpRequest.setHeader(Object map);

呼び出しパラメーター:

  • map: オブジェクト、設定するキーと値のデータ辞書を指定します

指定された名前でメッセージ ヘッダーのグループを設定します。データを設定すると、キー値に対応する値が変更され、同じキー値で残りのメッセージ ヘッダーがクリアされます

1 2
HttpRequest.setHeader(String name, Array values);

呼び出しパラメーター:

  • name: 文字列、設定するキー値を指定します
  • values: 配列、設定するデータのセットを指定

メッセージ ヘッダーを設定します。設定データは、キー値に対応する最初の値を変更し、同じキー値の残りのメッセージ ヘッダーをクリアします。

1 2
HttpRequest.setHeader(String name, String value);

呼び出しパラメーター:

  • name: 文字列、設定するキー値を指定します
  • value: 文字列、設定するデータを指定

removeHeader

指定されたキー値のすべてのメッセージ ヘッダーを削除します

1
HttpRequest.removeHeader(String name);

呼び出しパラメーター:

  • name: 文字列、削除するキーを指定します

read

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

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

呼び出しパラメーター:

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

返される結果:

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

readAll

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

1
Buffer HttpRequest.readAll() async;

返される結果:

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

write

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

1
HttpRequest.write(Buffer data) async;

呼び出しパラメーター:

  • data:Buffer、書き込むデータが与えられた場合

json

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

1
Value HttpRequest.json(Value data);

呼び出しパラメーター:

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

返される結果:

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

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

1
Value HttpRequest.json();

返される結果:

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

pack

msgpack指定されたデータをエンコードして書き込む

1
Value HttpRequest.pack(Value data);

呼び出しパラメーター:

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

返される結果:

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

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

1
Value HttpRequest.pack();

返される結果:

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

end

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

1
HttpRequest.end();

isEnded

現在のメッセージが終了したかどうかを問い合わせる

1
Boolean HttpRequest.isEnded();

返される結果:

  • Boolean、終了したら true を返す

clear

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

1
HttpRequest.clear();

sendTo

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

1
HttpRequest.sendTo(Stream stm) async;

呼び出しパラメーター:

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

readFrom

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

1
HttpRequest.readFrom(Stream stm) async;

呼び出しパラメーター:

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

toString

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

1
String HttpRequest.toString();

返される結果:

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

toJSON

オブジェクトの JSON 形式表現を返します。通常は、オブジェクトによって定義された読み取り可能なプロパティのセットを返します

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

呼び出しパラメーター:

  • key:文字列、未使用

返される結果:

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