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

オブジェクトHttpResponse

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>HttpResponse|new HttpResponse()|statusCode;statusMessage;cookies|writeHead();addCookie();redirect();sendHeader()] [object] <:- [Message] [Message] <:- [HttpMessage] [HttpMessage] <:- [HttpResponse] Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() HttpResponse new HttpResponse() statusCode statusMessage cookies writeHead() addCookie() redirect() sendHeader() HttpMessage protocol headers keepAlive upgrade maxHeadersCount maxBodySize socket hasHeader() firstHeader() allHeader() addHeader() setHeader() removeHeader() object toString() toJSON()

コンストラクタ

HttpResponse

新しいHttpResponseオブジェクトを作成するためのHttpResponseコンストラクタ

1
new HttpResponse();

絶え間ない

TEXT

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

1
const HttpResponse.TEXT = 1;

BINARY

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

1
const HttpResponse.BINARY = 2;

メンバー属性

statusCode

整数、クエリ、および応答メッセージの戻りステータスの設定

1
Integer HttpResponse.statusCode;

statusMessage

応答メッセージの戻りメッセージを文字列、クエリ、および設定します

1
String HttpResponse.statusMessage;

cookies

NArray、現在のメッセージを返します HttpCookie オブジェクトリスト

1
readonly NArray HttpResponse.cookies;

protocol

文字列、プロトコルバージョン情報、許可される形式は次のとおりです:HTTP /#。#

1
String HttpResponse.protocol;

headers

HttpCollection、メッセージに含まれています http メッセージヘッダーのコンテナ、読み取り専用属性

1
readonly HttpCollection HttpResponse.headers;

keepAlive

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

1
Boolean HttpResponse.keepAlive;

upgrade

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

1
Boolean HttpResponse.upgrade;

maxHeadersCount

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

1
Integer HttpResponse.maxHeadersCount;

maxBodySize

整数、クエリ、および本文の最大サイズの設定(MB単位)。デフォルトは64です。

1
Integer HttpResponse.maxBodySize;

socket

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

1
readonly Stream HttpResponse.socket;

value

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

1
String HttpResponse.value;

params

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

1
readonly NArray HttpResponse.params;

type

整数、メッセージタイプ

1
Integer HttpResponse.type;

data

値、メッセージのデータを照会します。この属性は、コンテンツタイプに応じて異なるデータを返します。テキストの場合は、テキストを返します。 json 帰るとき json、その他の場合はバイナリに戻ります

1
readonly Value HttpResponse.data;

body

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

1
SeekableStream HttpResponse.body;

length

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

1
readonly Long HttpResponse.length;

stream

Stream、メッセージreadFrom時にストリームオブジェクトをクエリします

1
readonly Stream HttpResponse.stream;

lastError

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

1
String HttpResponse.lastError;

メンバー関数

writeHead

応答メッセージの戻りステータスを設定し、メッセージを返し、応答ヘッダーを追加します

1 2 3
HttpResponse.writeHead(Integer statusCode, String statusMessage, Object headers = {});

呼び出しパラメーター:

  • statusCode:整数、応答メッセージの戻りステータスを指定します
  • statusMessage:文字列、応答メッセージの戻りメッセージを指定します
  • headers:オブジェクト、応答メッセージに追加された応答ヘッダーを指定します

応答メッセージの戻りステータスを設定し、メッセージを返し、応答ヘッダーを追加します

1 2
HttpResponse.writeHead(Integer statusCode, Object headers = {});

呼び出しパラメーター:

  • statusCode:整数、応答メッセージの戻りステータスを指定します
  • headers:オブジェクト、応答メッセージに追加された応答ヘッダーを指定します

addCookie

クッキーに1つ追加する HttpCookie 物体

1
HttpResponse.addCookie(HttpCookie cookie);

呼び出しパラメーター:


redirect

クライアントにリダイレクトを送信する

1
HttpResponse.redirect(String url);

呼び出しパラメーター:

  • url:文字列、リダイレクトされたアドレス

クライアントにリダイレクトを送信する

1 2
HttpResponse.redirect(Integer statusCode, String url);

呼び出しパラメーター:

  • statusCode:整数、応答メッセージの戻りステータスを指定します。受け入れられるステータスは、301、302、307です。
  • url:文字列、リダイレクトされたアドレス

sendHeader

書式設定のみを送信 http 指定されたストリームオブジェクトに移動します

1
HttpResponse.sendHeader(Stream stm) async;

呼び出しパラメーター:

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

hasHeader

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

1
Boolean HttpResponse.hasHeader(String name);

呼び出しパラメーター:

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

戻り結果:

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

firstHeader

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

1
String HttpResponse.firstHeader(String name);

呼び出しパラメーター:

  • name:文字列、照会するキー値を指定します

戻り結果:

  • String、キー値に対応する値を返します。存在しない場合は、未定義を返します。

allHeader

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

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

呼び出しパラメーター:

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

戻り結果:

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

addHeader

メッセージヘッダーを追加します。データを追加しても、既存のキー値のメッセージヘッダーは変更されません。

1
HttpResponse.addHeader(Object map);

呼び出しパラメーター:

  • map:オブジェクト、追加するKey-Valueデータディクショナリを指定します

指定された名前のメッセージヘッダーのセットを追加します。データを追加しても、既存のキー値のメッセージヘッダーは変更されません。

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

呼び出しパラメーター:

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

メッセージヘッダーを追加します。データを追加しても、既存のキー値のメッセージヘッダーは変更されません。

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

呼び出しパラメーター:

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

setHeader

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

1
HttpResponse.setHeader(Object map);

呼び出しパラメーター:

  • map:オブジェクト、設定するKey-Valueデータディクショナリを指定します

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

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

呼び出しパラメーター:

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

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

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

呼び出しパラメーター:

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

removeHeader

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

1
HttpResponse.removeHeader(String name);

呼び出しパラメーター:

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

read

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

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

呼び出しパラメーター:

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

戻り結果:

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

readAll

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

1
Buffer HttpResponse.readAll() async;

戻り結果:

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

write

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

1
HttpResponse.write(Buffer data) async;

呼び出しパラメーター:

  • dataBuffer、書き込まれるデータが与えられた場合

json

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

1
Value HttpResponse.json(Value data);

呼び出しパラメーター:

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

戻り結果:

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

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

1
Value HttpResponse.json();

戻り結果:

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

pack

msgpack 指定されたデータを書き込むためにエンコードします

1
Value HttpResponse.pack(Value data);

呼び出しパラメーター:

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

戻り結果:

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

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

1
Value HttpResponse.pack();

戻り結果:

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

end

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

1
HttpResponse.end();

isEnded

現在のメッセージが終了したかどうかを照会します

1
Boolean HttpResponse.isEnded();

戻り結果:

  • Boolean、最後にtrueを返します

clear

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

1
HttpResponse.clear();

sendTo

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

1
HttpResponse.sendTo(Stream stm) async;

呼び出しパラメーター:

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

readFrom

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

1
HttpResponse.readFrom(Stream stm) async;

呼び出しパラメーター:

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

toString

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

1
String HttpResponse.toString();

戻り結果:

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

toJSON

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

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

呼び出しパラメーター:

  • key:文字列、未使用

戻り結果:

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