オブジェクト HttpMessage

http 基本メッセージオブジェクト

継承

絶え間ない

TEXT

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

1
const HttpMessage.TEXT = 1;

---

BINARY

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

1
const HttpMessage.BINARY = 2;

メンバーの属性

protocol

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

1
String HttpMessage.protocol;

---

headers

HttpCollection、メッセージに同梱 http メッセージ ヘッダーのコンテナー、読み取り専用属性

1
readonly HttpCollection HttpMessage.headers;

---

keepAlive

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

1
Boolean HttpMessage.keepAlive;

---

upgrade

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

1
Boolean HttpMessage.upgrade;

---

maxHeadersCount

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

1
Integer HttpMessage.maxHeadersCount;

---

maxBodySize

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

1
Integer HttpMessage.maxBodySize;

---

socket

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

1
readonly Stream HttpMessage.socket;

---

value

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

1
String HttpMessage.value;

---

params

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

1
readonly NArray HttpMessage.params;

---

type

整数、メッセージタイプ

1
Integer HttpMessage.type;

---

data

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

1
readonly Value HttpMessage.data;

---

body

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

1
SeekableStream HttpMessage.body;

---

length

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

1
readonly Long HttpMessage.length;

---

stream

Stream、メッセージがreadFromのときにストリームオブジェクトを照会します

1
readonly Stream HttpMessage.stream;

---

lastError

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

1
String HttpMessage.lastError;

メンバー関数

hasHeader

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

1
Boolean HttpMessage.hasHeader(String name);

呼び出しパラメータ:

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

結果を返す:

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

---

firstHeader

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

1
String HttpMessage.firstHeader(String name);

呼び出しパラメータ:

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

結果を返す:

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

---

allHeader

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

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

呼び出しパラメータ:

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

結果を返す:

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

---

addHeader

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

1
HttpMessage.addHeader(Object map);

呼び出しパラメータ:

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

---

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

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

呼び出しパラメータ:

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

---

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

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

呼び出しパラメータ:

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

---

setHeader

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

1
HttpMessage.setHeader(Object map);

呼び出しパラメータ:

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

---

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

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

呼び出しパラメータ:

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

---

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

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

呼び出しパラメータ:

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

---

removeHeader

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

1
HttpMessage.removeHeader(String name);

呼び出しパラメータ:

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

---

read

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

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

呼び出しパラメータ:

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

結果を返す:

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

---

readAll

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

1
Buffer HttpMessage.readAll() async;

結果を返す:

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

---

write

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

1
HttpMessage.write(Buffer data) async;

呼び出しパラメータ:

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

---

json

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

1
Value HttpMessage.json(Value data);

呼び出しパラメータ:

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

結果を返す:

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

---

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

1
Value HttpMessage.json();

結果を返す:

• Value、解析結果を返す

---

pack

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

1
Value HttpMessage.pack(Value data);

呼び出しパラメータ:

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

結果を返す:

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

---

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

1
Value HttpMessage.pack();

結果を返す:

• Value、解析結果を返す

---

end

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

1
HttpMessage.end();

---

isEnded

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

1
Boolean HttpMessage.isEnded();

結果を返す:

• Boolean、最後にtrueを返す

---

clear

メッセージの内容を消去する

1
HttpMessage.clear();

---

sendTo

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

1
HttpMessage.sendTo(Stream stm) async;

呼び出しパラメータ:

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

---

readFrom

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

1
HttpMessage.readFrom(Stream stm) async;

呼び出しパラメータ:

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

---

toString

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

1
String HttpMessage.toString();

結果を返す:

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

---

toJSON

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

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

呼び出しパラメータ:

• key: ストリング、未使用

結果を返す:

• Value、シリアライズ可能なJSONを含む値を返します