Objekt eingebautes Objekt
  1. Titelseite
  2. Eingebaute Objekte
  3. Objekt HttpResponse

Objekt HttpResponse

http Antwortnachrichtenobjekt

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

Konstrukteur

HttpResponse

HttpResponse-Konstruktor zum Erstellen eines neuen HttpResponse-Objekts

1
new HttpResponse();

Konstante

TEXT

Geben Sie den Nachrichtentyp 1 an, der einen Texttyp darstellt

1
const HttpResponse.TEXT = 1;

BINARY

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

1
const HttpResponse.BINARY = 2;

Mitgliedsattribute

statusCode

Integer, Abfragen und Setzen des Rückgabestatus der Antwortnachricht

1
Integer HttpResponse.statusCode;

statusMessage

String, Abfrage und Einstellung der Rückmeldung der Antwortnachricht

1
String HttpResponse.statusMessage;

cookies

NArray, gibt die aktuelle Nachricht zurück HttpCookie Objektliste

1
readonly NArray HttpResponse.cookies;

protocol

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

1
String HttpResponse.protocol;

headers

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

1
readonly HttpCollection HttpResponse.headers;

keepAlive

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

1
Boolean HttpResponse.keepAlive;

upgrade

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

1
Boolean HttpResponse.upgrade;

maxHeadersCount

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

1
Integer HttpResponse.maxHeadersCount;

maxBodySize

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

1
Integer HttpResponse.maxBodySize;

socket

Stream, Abfrage des Quellsockets des aktuellen Objekts

1
readonly Stream HttpResponse.socket;

value

String, der grundlegende Inhalt der Nachricht

1
String HttpResponse.value;

params

NArray, die grundlegenden Parameter der Nachricht

1
readonly NArray HttpResponse.params;

type

Ganzzahl, Nachrichtentyp

1
Integer HttpResponse.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 HttpResponse.data;

body

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

1
SeekableStream HttpResponse.body;

length

Long, die Länge des Datenteils der Nachricht

1
readonly Long HttpResponse.length;

stream

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

1
readonly Stream HttpResponse.stream;

lastError

String, Abfrage und Einstellung des letzten Fehlers der Nachrichtenverarbeitung

1
String HttpResponse.lastError;

Mitgliederfunktion

writeHead

Legen Sie den Rückgabestatus der Antwortnachricht fest, geben Sie die Nachricht zurück und fügen Sie den Antwortheader hinzu

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

Aufrufparameter:

  • statusCode: Integer, geben Sie den Rückgabestatus der Antwortnachricht an
  • statusMessage: String, geben Sie die Antwortnachricht der Antwortnachricht an
  • headers: Objekt, geben Sie den Antwortheader an, der der Antwortnachricht hinzugefügt wurde

Legen Sie den Rückgabestatus der Antwortnachricht fest, geben Sie die Nachricht zurück und fügen Sie den Antwortheader hinzu

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

Aufrufparameter:

  • statusCode: Integer, geben Sie den Rückgabestatus der Antwortnachricht an
  • headers: Objekt, geben Sie den Antwortheader an, der der Antwortnachricht hinzugefügt wurde

addCookie

Fügen Sie einen zu Cookies hinzu HttpCookie Objekt

1
HttpResponse.addCookie(HttpCookie cookie);

Aufrufparameter:

redirect

Weiterleitung an Client senden

1
HttpResponse.redirect(String url);

Aufrufparameter:

  • url: String, umgeleitete Adresse

Weiterleitung an Client senden

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

Aufrufparameter:

  • statusCode: Integer, geben Sie den Rückgabestatus der Antwortnachricht an, der akzeptierte Status ist: 301, 302, 307
  • url: String, umgeleitete Adresse

sendHeader

Nur Formatierung senden http Gehe zum angegebenen Stream-Objekt

1
HttpResponse.sendHeader(Stream stm) async;

Aufrufparameter:

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

hasHeader

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

1
Boolean HttpResponse.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 HttpResponse.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 HttpResponse.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
HttpResponse.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
HttpResponse.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
HttpResponse.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
HttpResponse.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
HttpResponse.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
HttpResponse.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
HttpResponse.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 HttpResponse.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 HttpResponse.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
HttpResponse.write(Buffer data) async;

Aufrufparameter:

  • data: Buffer, Angesichts der zu schreibenden Daten

json

Schreiben Sie die angegebenen Daten in JSON-Codierung

1
Value HttpResponse.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 HttpResponse.json();

Ergebnis zurückgeben:

  • Value, Das geparste Ergebnis zurückgeben

pack

von msgpack Codieren, um die angegebenen Daten zu schreiben

1
Value HttpResponse.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 HttpResponse.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
HttpResponse.end();

isEnded

Abfrage, ob die aktuelle Nachricht zu Ende ist

1
Boolean HttpResponse.isEnded();

Ergebnis zurückgeben:

  • Boolean, Gib am Ende true zurück

clear

Inhalt der Nachricht löschen

1
HttpResponse.clear();

sendTo

Senden Sie eine formatierte Nachricht an das angegebene Stream-Objekt

1
HttpResponse.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
HttpResponse.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 HttpResponse.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 HttpResponse.toJSON(String key = "");

Aufrufparameter:

  • key: String, unbenutzt

Ergebnis zurückgeben:

  • Value, Gibt einen Wert zurück, der JSON serialisierbar enthält
© Copyright 2012-2021 fibjs.org | Unterstützen Sie uns