オブジェクトHTTPレスポンス

HttpResponse は HTTP 応答オブジェクトです。HttpRequest.responseオブジェクトが HTTP サーバーのデータ応答を完了するか、またはhttp.requestサーバーから返されたリクエスト応答データ

次の例は、次の方法を示しています。http.Serverで使用されるサンプルコードは次のとおりです。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
const http = require('http');

const server = new http.Server(8080, (request) => {
// retreive the response object
const response = request.response;
// set the status code
response.statusCode = 200;
// set the content type to text/plain
response.setHeader('Content-Type', 'text/plain');
// write the response body
response.write('ok');
});

server.start();

相続関係

コンストラクタ

HttpResponse

HttpResponse コンストラクター、新しい HttpResponse オブジェクトを作成します

1
new HttpResponse();

絶え間ない

TEXT

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

1
const HttpResponse.TEXT = 1;

BINARY

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

1
const HttpResponse.BINARY = 2;

メンバーのプロパティ

statusCode

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

1Integer HttpResponse.statusCode;

statusMessage

文字列、クエリ、応答メッセージの返信メッセージを設定します

1
String HttpResponse.statusMessage;

status

整数。応答メッセージの戻りステータスをクエリおよび設定します。statusCode に相当します。

1Integer HttpResponse.status;

ok

ブール値、現在の応答が正常かどうかを問い合わせます

1
readonly Boolean HttpResponse.ok;

cookies

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

1readonly NArray HttpResponse.cookies;

protocol

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

1
String HttpResponse.protocol;

headers

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

1readonly HttpCollection HttpResponse.headers;

keepAlive

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

1
Boolean HttpResponse.keepAlive;

upgrade

ブール値、アップグレードプロトコルであるかどうかをクエリおよび設定します

1
Boolean HttpResponse.upgrade;

maxHeadersCount

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

1Integer HttpResponse.maxHeadersCount;

maxHeaderSize

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

1Integer HttpResponse.maxHeaderSize;

maxBodySize

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

1Integer HttpResponse.maxBodySize;

socket

Stream, 現在のオブジェクトのソースソケットをクエリします。

1readonly Stream HttpResponse.socket;

value

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

1
String HttpResponse.value;

params

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

1readonly NArray HttpResponse.params;

type

整数、メッセージタイプ

1Integer HttpResponse.type;

data

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

1readonly Value HttpResponse.data;

body

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

1SeekableStream HttpResponse.body;

length

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

1readonly Long HttpResponse.length;

stream

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

1readonly Stream HttpResponse.stream;

lastError

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

1
String HttpResponse.lastError;

メンバー関数

writeHead

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

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

呼び出しパラメータ:

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

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

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

呼び出しパラメータ:

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

addCookie

Cookie に 1 つ追加しますHttpCookie物体

1HttpResponse.addCookie(HttpCookie cookie);

呼び出しパラメータ:

cookie:HttpCookieを指定し、HttpCookie物体

redirect

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

1
HttpResponse.redirect(String url);

呼び出しパラメータ:

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

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

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

呼び出しパラメータ:

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

sendHeader

フォーマット済みのみ送信http指定されたストリームオブジェクトに移動します

1
HttpResponse.sendHeader(Stream stm) async;

呼び出しパラメータ:

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

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: オブジェクト。追加するキーと値のデータディクショナリを指定します。

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

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: オブジェクト。設定するキーと値のデータディクショナリを指定します。

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

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;

呼び出しパラメータ:

data:Buffer、書き込まれるデータが与えられると、

json

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

1Value HttpResponse.json(Value data);

呼び出しパラメータ:

data: 書き込まれるデータの値

返される結果:

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

メッセージ内のデータを JSON エンコードとして解析します

1Value HttpResponse.json();

返される結果:

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

pack

によるmsgpackエンコーディングは指定されたデータを書き込みます

1Value HttpResponse.pack(Value data);

呼び出しパラメータ:

data: 書き込まれるデータの値

返される結果:

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

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

1Value HttpResponse.pack();

返される結果:

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

end

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

1HttpResponse.end();

isEnded

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

1
Boolean HttpResponse.isEnded();

返される結果:

Boolean、終了すると true を返します

clear

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

1HttpResponse.clear();

sendTo

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

1
HttpResponse.sendTo(Stream stm) async;

呼び出しパラメータ:

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

readFrom

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

1
HttpResponse.readFrom(Stream stm) async;

呼び出しパラメータ:

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

toString

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

1
String HttpResponse.toString();

返される結果:

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

toJSON

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

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

呼び出しパラメータ:

key: 文字列、使用されません

返される結果:

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

開発ガイド

基本モジュール

組み込みオブジェクト

コミュニティモジュール

オブジェクトHTTPレスポンス

相続関係

コンストラクタ

HttpResponse

絶え間ない

TEXT

BINARY

メンバーのプロパティ

statusCode

statusMessage

status

ok

cookies

protocol

headers

keepAlive

upgrade

maxHeadersCount

maxHeaderSize

maxBodySize

socket

value

params

type

data

body

length

stream

lastError

メンバー関数

writeHead

addCookie

redirect

sendHeader

hasHeader

firstHeader

allHeader

addHeader

setHeader

removeHeader

read

readAll

write

json

pack

end

isEnded

clear

sendTo

readFrom

toString

toJSON