Objekt eingebautes Objekt

Objekt HttpRequest

http Nachrichtenobjekt anfordern

Nachlass

#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()

Konstrukteur

HttpRequest

HttpRequest-Konstruktor zum Erstellen eines neuen HttpRequest-Objekts

1
new HttpRequest();

Konstante

TEXT

Geben Sie den Nachrichtentyp 1 an, der einen Texttyp darstellt

1
const HttpRequest.TEXT = 1;

BINARY

Geben Sie Nachrichtentyp 2 an, der einen binären Typ darstellt

1
const HttpRequest.BINARY = 2;

Mitgliedsattribute

response

HttpResponse, Antwortnachrichtenobjekt abrufen

1
readonly HttpResponse HttpRequest.response;

method

String, Abfrage und Anforderungsmethode festlegen

1
String HttpRequest.method;

address

String, Abfrage und Einstellung der Anfrageadresse

1
String HttpRequest.address;

queryString

String, Abfrage und Set-Anfrage-Abfrage-String

1
String HttpRequest.queryString;

cookies

HttpCollection, Holen Sie sich den Container mit den Nachrichten-Cookies

1
readonly HttpCollection HttpRequest.cookies;

form

HttpCollection, Holen Sie sich den Container mit dem Nachrichtenformular

1
readonly HttpCollection HttpRequest.form;

query

HttpCollection, Holen Sie sich den Container, der die Nachrichtenabfrage enthält

1
readonly HttpCollection HttpRequest.query;

protocol

String, Protokollversionsinformationen, das zulässige Format ist: HTTP/#.#

1
String HttpRequest.protocol;

headers

HttpCollection, In der Nachricht enthalten http Der Container des Nachrichtenheaders, schreibgeschütztes Attribut

1
readonly HttpCollection HttpRequest.headers;

keepAlive

Boolean, Abfrage und Festlegen, ob die Verbindung beibehalten werden soll

1
Boolean HttpRequest.keepAlive;

upgrade

Boolean, Abfrage und Festlegen, ob es sich um eine Upgrade-Vereinbarung handelt

1
Boolean HttpRequest.upgrade;

maxHeadersCount

Integer, Abfragen und Festlegen der maximalen Anzahl von Anforderungsheadern, der Standardwert ist 128

1
Integer HttpRequest.maxHeadersCount;

maxBodySize

Integer, Abfrage und Festlegen der maximalen Größe des Körpers, in MB, der Standardwert ist 64

1
Integer HttpRequest.maxBodySize;

socket

Stream, Abfrage des Quellsockets des aktuellen Objekts

1
readonly Stream HttpRequest.socket;

value

String, der grundlegende Inhalt der Nachricht

1
String HttpRequest.value;

params

NArray, die grundlegenden Parameter der Nachricht

1
readonly NArray HttpRequest.params;

type

Ganzzahl, Nachrichtentyp

1
Integer HttpRequest.type;

data

Wert, fragt die Daten der Nachricht ab, dieses Attribut gibt je nach Inhaltstyp unterschiedliche Daten zurück, wenn es sich um Text handelt, gibt es den Text zurück, der ist json Bei der Rückkehr json, Andere Zeiten kehren zu binär zurück

1
readonly Value HttpRequest.data;

body

SeekableStream, Das Stream-Objekt, das den Datenteil der Nachricht enthält

1
SeekableStream HttpRequest.body;

length

Long, die Länge des Datenteils der Nachricht

1
readonly Long HttpRequest.length;

stream

Stream, Fragt das Stream-Objekt ab, wenn die Nachricht readFrom

1
readonly Stream HttpRequest.stream;

lastError

String, Abfrage und Einstellung des letzten Fehlers der Nachrichtenverarbeitung

1
String HttpRequest.lastError;

Mitgliederfunktion

hasHeader

Prüfen Sie, ob ein Nachrichtenheader mit dem angegebenen Schlüsselwert vorhanden ist

1
Boolean HttpRequest.hasHeader(String name);

Aufrufparameter:

  • name: String, geben Sie den zu überprüfenden Schlüsselwert an

Ergebnis zurückgeben:

  • Boolean, Gibt zurück, ob der Schlüsselwert vorhanden ist

firstHeader

Abfrage des ersten Nachrichtenheaders des angegebenen Schlüsselwerts

1
String HttpRequest.firstHeader(String name);

Aufrufparameter:

  • name: String, geben Sie den abzufragenden Schlüsselwert an

Ergebnis zurückgeben:

  • String, Gibt den Wert zurück, der dem Schlüsselwert entspricht, wenn er nicht existiert, gibt undefined zurück

allHeader

Alle Nachrichtenheader des angegebenen Schlüsselwerts abfragen

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

Aufrufparameter:

  • name: String, geben Sie den abzufragenden Schlüsselwert an, übergeben Sie einen leeren String, um das Ergebnis aller Schlüsselwerte zurückzugeben

Ergebnis zurückgeben:

  • NObject, Gibt ein Array aller Werte zurück, die dem Schlüsselwert entsprechen, wenn die Daten nicht vorhanden sind, wird null zurückgegeben

addHeader

Fügen Sie einen Nachrichtenheader hinzu, das Hinzufügen von Daten ändert nicht den Nachrichtenheader des vorhandenen Schlüsselwerts

1
HttpRequest.addHeader(Object map);

Aufrufparameter:

  • map: Objekt, geben Sie das hinzuzufügende Schlüsselwert-Datenwörterbuch an

Fügen Sie einen Satz von Nachrichtenheadern mit einem bestimmten Namen hinzu, das Hinzufügen von Daten ändert nicht die Nachrichtenheader des vorhandenen Schlüsselwerts

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

Aufrufparameter:

  • name: String, geben Sie den hinzuzufügenden Schlüsselwert an
  • values: Array, geben Sie einen Datensatz an, der hinzugefügt werden soll

Fügen Sie einen Nachrichtenheader hinzu, das Hinzufügen von Daten ändert nicht den Nachrichtenheader des vorhandenen Schlüsselwerts

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

Aufrufparameter:

  • name: String, geben Sie den hinzuzufügenden Schlüsselwert an
  • value: String, geben Sie die hinzuzufügenden Daten an

setHeader

Wenn Sie einen Nachrichtenheader festlegen, ändern die Einstellungsdaten den ersten Wert entsprechend dem Schlüsselwert und löschen die verbleibenden Nachrichtenheader mit demselben Schlüsselwert

1
HttpRequest.setHeader(Object map);

Aufrufparameter:

  • map: Objekt, geben Sie das festzulegende Schlüsselwert-Datenwörterbuch an

Legen Sie einen Satz von Nachrichtenkopfzeilen mit einem bestimmten Namen fest, die Einstellungsdaten ändern den dem Schlüsselwert entsprechenden Wert und löschen den Rest der Nachrichtenkopfzeilen mit demselben Schlüsselwert

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

Aufrufparameter:

  • name: String, geben Sie den zu setzenden Schlüsselwert an
  • values: Array, geben Sie einen Datensatz an, der eingestellt werden soll

Wenn Sie einen Nachrichtenheader festlegen, ändern die Einstellungsdaten den ersten Wert entsprechend dem Schlüsselwert und löschen die verbleibenden Nachrichtenheader mit demselben Schlüsselwert

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

Aufrufparameter:

  • name: String, geben Sie den zu setzenden Schlüsselwert an
  • value: String, geben Sie die einzustellenden Daten an

removeHeader

Löschen Sie alle Nachrichtenheader des angegebenen Schlüsselwerts

1
HttpRequest.removeHeader(String name);

Aufrufparameter:

  • name: String, geben Sie den zu löschenden Schlüsselwert an

read

Liest die Daten der angegebenen Größe aus dem Stream, diese Methode ist der Alias ​​der entsprechenden Methode von body

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

Aufrufparameter:

  • bytes: Integer, geben Sie die zu lesende Datenmenge an, standardmäßig wird ein Datenblock zufälliger Größe gelesen, die Größe der gelesenen Daten hängt vom Gerät ab

Ergebnis zurückgeben:

  • Buffer, Die aus dem Stream gelesenen Daten zurückgeben, wenn keine Daten zum Lesen vorhanden sind oder die Verbindung unterbrochen ist, dann null zurückgeben

readAll

Lies alle verbleibenden Daten aus dem Stream, diese Methode ist ein Alias ​​der entsprechenden Methode von body

1
Buffer HttpRequest.readAll() async;

Ergebnis zurückgeben:

  • Buffer, Die aus dem Stream gelesenen Daten zurückgeben, wenn keine Daten zum Lesen vorhanden sind oder die Verbindung unterbrochen ist, dann null zurückgeben

write

Schreiben Sie die angegebenen Daten, diese Methode ist der Alias ​​der entsprechenden Methode von body

1
HttpRequest.write(Buffer data) async;

Aufrufparameter:

  • data: Buffer, Angesichts der zu schreibenden Daten

json

Schreiben Sie die angegebenen Daten in JSON-Codierung

1
Value HttpRequest.json(Value data);

Aufrufparameter:

  • data: Wert, gegeben die zu schreibenden Daten

Ergebnis zurückgeben:

  • Value, Diese Methode gibt keine Daten zurück

Analysieren Sie die Daten in der Nachricht in JSON-Codierung

1
Value HttpRequest.json();

Ergebnis zurückgeben:

  • Value, Das geparste Ergebnis zurückgeben

pack

von msgpack Codieren, um die angegebenen Daten zu schreiben

1
Value HttpRequest.pack(Value data);

Aufrufparameter:

  • data: Wert, gegeben die zu schreibenden Daten

Ergebnis zurückgeben:

  • Value, Diese Methode gibt keine Daten zurück

von msgpack Codieren und Parsen der Daten in der Nachricht

1
Value HttpRequest.pack();

Ergebnis zurückgeben:

  • Value, Das geparste Ergebnis zurückgeben

end

Setzen Sie das Ende der aktuellen Nachrichtenverarbeitung,Chain Der Prozessor setzt nachfolgende Transaktionen nicht fort

1
HttpRequest.end();

isEnded

Abfrage, ob die aktuelle Nachricht zu Ende ist

1
Boolean HttpRequest.isEnded();

Ergebnis zurückgeben:

  • Boolean, Gib am Ende true zurück

clear

Inhalt der Nachricht löschen

1
HttpRequest.clear();

sendTo

Senden Sie eine formatierte Nachricht an das angegebene Stream-Objekt

1
HttpRequest.sendTo(Stream stm) async;

Aufrufparameter:

  • stm: Stream, Geben Sie das Stream-Objekt an, um formatierte Nachrichten zu empfangen

readFrom

Lesen Sie die formatierte Nachricht aus dem angegebenen Cache-Stream-Objekt und analysieren Sie das Füllobjekt

1
HttpRequest.readFrom(Stream stm) async;

Aufrufparameter:

  • stm: Stream, Geben Sie das Stream-Objekt zum Lesen formatierter Nachrichten an

toString

Gibt die String-Darstellung des Objekts zurück, gibt im Allgemeinen "[Native Object]" zurück, das Objekt kann entsprechend seiner eigenen Eigenschaften neu implementiert werden

1
String HttpRequest.toString();

Ergebnis zurückgeben:

  • String, Gibt die String-Darstellung des Objekts zurück

toJSON

Gibt die Darstellung des Objekts im JSON-Format zurück, gibt im Allgemeinen eine Sammlung von lesbaren Attributen zurück, die durch das Objekt definiert sind

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

Aufrufparameter:

  • key: String, unbenutzt

Ergebnis zurückgeben:

  • Value, Gibt einen Wert zurück, der JSON serialisierbar enthält