Objecte objecte incorporat

Objecte HttpResponse

http Objecte de missatge de resposta

Herència

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

Constructor

HttpResponse

Constructor HttpResponse per crear un nou objecte HttpResponse

1
new HttpResponse();

constant

TEXT

Especifiqueu el tipus de missatge 1, que representa un tipus de text

1
const HttpResponse.TEXT = 1;

BINARY

Especifiqueu el tipus de missatge 2, que representa un tipus binari

1
const HttpResponse.BINARY = 2;

Atributs de membre

statusCode

Enter, consulteu i configureu l'estat de retorn del missatge de resposta

1
Integer HttpResponse.statusCode;

statusMessage

Cadena, consulta i defineix el missatge de retorn del missatge de resposta

1
String HttpResponse.statusMessage;

cookies

NArray, retorna el missatge actual HttpCookie Llista d'objectes

1
readonly NArray HttpResponse.cookies;

protocol

Cadena, informació de la versió del protocol, el format permès és: HTTP /#.#

1
String HttpResponse.protocol;

headers

HttpCollection, Inclòs al missatge http El contenidor de la capçalera del missatge, atribut de només lectura

1
readonly HttpCollection HttpResponse.headers;

keepAlive

Booleà, consulta i defineix si vols mantenir la connexió

1
Boolean HttpResponse.keepAlive;

upgrade

Booleà, consulta i defineix si es tracta d'un acord d'actualització

1
Boolean HttpResponse.upgrade;

maxHeadersCount

Enter, consulteu i definiu el nombre màxim de capçaleres de sol·licitud; el valor per defecte és 128

1
Integer HttpResponse.maxHeadersCount;

maxBodySize

Enter, consulta i estableix la mida màxima del cos, en MB, el valor per defecte és 64

1
Integer HttpResponse.maxBodySize;

socket

Stream, Consulteu el sòcol font de l'objecte actual

1
readonly Stream HttpResponse.socket;

value

String, el contingut bàsic del missatge

1
String HttpResponse.value;

params

NArray, els paràmetres bàsics del missatge

1
readonly NArray HttpResponse.params;

type

Enter, tipus de missatge

1
Integer HttpResponse.type;

data

Valor, consulta les dades del missatge, aquest atribut retornarà dades diferents segons el tipus de contingut, quan sigui text, retorna el text, que és json En tornar json, Altres vegades tornen al binari

1
readonly Value HttpResponse.data;

body

SeekableStream, L'objecte de flux que conté la part de dades del missatge

1
SeekableStream HttpResponse.body;

length

Llarg, la longitud de la part de dades del missatge

1
readonly Long HttpResponse.length;

stream

Stream, Consulteu l'objecte de flux quan el missatge es llegeix des de

1
readonly Stream HttpResponse.stream;

lastError

Cadena, consulta i defineix l'últim error de processament de missatges

1
String HttpResponse.lastError;

Funció de membre

writeHead

Establiu l'estat de retorn del missatge de resposta, torneu-lo i afegiu la capçalera de resposta

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

Paràmetres de trucada:

  • statusCode: Enter, especifiqueu l'estat de retorn del missatge de resposta
  • statusMessage: Cadena, especifiqueu el missatge de retorn del missatge de resposta
  • headers: Objecte, especifiqueu la capçalera de resposta afegida al missatge de resposta

Establiu l'estat de retorn del missatge de resposta, torneu-lo i afegiu la capçalera de resposta

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

Paràmetres de trucada:

  • statusCode: Enter, especifiqueu l'estat de retorn del missatge de resposta
  • headers: Objecte, especifiqueu la capçalera de resposta afegida al missatge de resposta

addCookie

Afegiu-ne una a les galetes HttpCookie Objecte

1
HttpResponse.addCookie(HttpCookie cookie);

Paràmetres de trucada:


redirect

Enviar redirecció al client

1
HttpResponse.redirect(String url);

Paràmetres de trucada:

  • url: Cadena, adreça redirigida

Enviar redirecció al client

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

Paràmetres de trucada:

  • statusCode: Enter, especifiqueu l'estat de retorn del missatge de resposta; l'estat acceptat és: 301, 302, 307
  • url: Cadena, adreça redirigida

sendHeader

Envia només format http Dirigiu-vos a l'objecte de flux donat

1
HttpResponse.sendHeader(Stream stm) async;

Paràmetres de trucada:

  • stm: Stream, Especifiqueu l'objecte de flux per rebre missatges amb format

hasHeader

Comproveu si hi ha cap capçalera de missatge amb el valor de clau especificat

1
Boolean HttpResponse.hasHeader(String name);

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor de la clau que voleu comprovar

Resultat de retorn:

  • Boolean, Retorna si el valor de la clau existeix

firstHeader

Consulteu la primera capçalera del missatge del valor de clau especificat

1
String HttpResponse.firstHeader(String name);

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor clau que cal consultar

Resultat de retorn:

  • String, Retorna el valor corresponent al valor clau, si no existeix, torna indefinit

allHeader

Consulteu totes les capçaleres de missatge del valor de clau especificat

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor de la clau que cal consultar, passeu una cadena buida per retornar el resultat de tots els valors de la clau

Resultat de retorn:

  • NObject, Retorna una matriu de tots els valors corresponents al valor de la clau, si les dades no existeixen, torna nul

addHeader

Afegiu una capçalera de missatge, si afegiu dades no modifiqueu la capçalera del missatge del valor de la clau existent

1
HttpResponse.addHeader(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu el diccionari de dades valor-clau que voleu afegir

Afegiu un conjunt de capçaleres de missatge amb un nom especificat, si afegiu dades no modifiqueu les capçaleres del missatge del valor de la clau existent

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor clau que cal afegir
  • values: Matriu, especifiqueu un conjunt de dades que voleu afegir

Afegiu una capçalera de missatge, si afegiu dades no modifiqueu la capçalera del missatge del valor de la clau existent

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor clau que cal afegir
  • value: Cadena, especifiqueu les dades que voleu afegir

setHeader

Definiu una capçalera de missatge, si configureu les dades, es modificarà el primer valor corresponent al valor de la clau i esborraran les capçaleres de missatge restants amb el mateix valor de la clau.

1
HttpResponse.setHeader(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu el diccionari de dades valor-clau que cal establir

Definiu un conjunt de capçaleres de missatge amb un nom especificat, les dades de configuració modificaran el valor corresponent al valor de la clau i esborraran la resta de capçaleres de missatge amb el mateix valor de clau.

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor clau que cal establir
  • values: Matriu, especifiqueu un conjunt de dades que cal establir

Definiu una capçalera de missatge, si configureu les dades, es modificarà el primer valor corresponent al valor de la clau i esborraran les capçaleres de missatge restants amb el mateix valor de la clau.

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor clau que cal establir
  • value: Cadena, especifiqueu les dades que voleu establir

removeHeader

Suprimiu totes les capçaleres del missatge del valor de clau especificat

1
HttpResponse.removeHeader(String name);

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor de la clau que voleu suprimir

read

Llegiu les dades de la mida especificada del flux, aquest mètode és l'àlies del mètode de cos corresponent

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

Paràmetres de trucada:

  • bytes: Enter, especifiqueu la quantitat de dades que cal llegir, el valor per defecte és llegir un bloc de dades de mida aleatòria, la mida de les dades llegides depèn del dispositiu

Resultat de retorn:

  • Buffer, Torneu les dades llegides del flux, si no hi ha dades per llegir o si la connexió s'interromp, torneu a ser nul

readAll

Llegiu totes les dades restants del flux, aquest mètode és un àlies del mètode de cos corresponent

1
Buffer HttpResponse.readAll() async;

Resultat de retorn:

  • Buffer, Torneu les dades llegides del flux, si no hi ha dades per llegir o si la connexió s'interromp, torneu a ser nul

write

Escriviu les dades donades, aquest mètode és l'àlies del mètode de cos corresponent

1
HttpResponse.write(Buffer data) async;

Paràmetres de trucada:

  • data: Buffer, Tenint en compte les dades a escriure

json

Escriviu les dades donades a la codificació JSON

1
Value HttpResponse.json(Value data);

Paràmetres de trucada:

  • data: Valor, donades les dades que cal escriure

Resultat de retorn:

  • Value, Aquest mètode no retornarà dades

Analitzeu les dades del missatge a la codificació JSON

1
Value HttpResponse.json();

Resultat de retorn:

  • Value, Retorna el resultat analitzat

pack

per msgpack Codificar per escriure les dades donades

1
Value HttpResponse.pack(Value data);

Paràmetres de trucada:

  • data: Valor, donades les dades que cal escriure

Resultat de retorn:

  • Value, Aquest mètode no retornarà dades

per msgpack Codificació i anàlisi de les dades del missatge

1
Value HttpResponse.pack();

Resultat de retorn:

  • Value, Retorna el resultat analitzat

end

Definiu el final del processament actual del missatge,Chain El processador no continua les transaccions posteriors

1
HttpResponse.end();

isEnded

Consulteu si el missatge actual s'ha acabat

1
Boolean HttpResponse.isEnded();

Resultat de retorn:

  • Boolean, Torneu a cert al final

clear

Esborreu el contingut del missatge

1
HttpResponse.clear();

sendTo

Envieu un missatge formatat a l'objecte de flux donat

1
HttpResponse.sendTo(Stream stm) async;

Paràmetres de trucada:

  • stm: Stream, Especifiqueu l'objecte de flux per rebre missatges amb format

readFrom

Llegiu el missatge formatat de l'objecte de flux de memòria cau donat i analitzeu l'objecte d'emplenament

1
HttpResponse.readFrom(Stream stm) async;

Paràmetres de trucada:

  • stm: Stream, Especifiqueu l'objecte de flux per llegir els missatges formatats

toString

Retorna la representació de cadena de l'objecte, generalment retorna "[Objecte natiu]", l'objecte es pot tornar a implementar segons les seves pròpies característiques

1
String HttpResponse.toString();

Resultat de retorn:

  • String, Retorna la representació de cadena de l'objecte

toJSON

Retorna la representació en format JSON de l'objecte, generalment retorna una col·lecció d'atributs llegibles definits per l'objecte

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

Paràmetres de trucada:

  • key: Cadena, sense utilitzar

Resultat de retorn:

  • Value, Retorna un valor que conté JSON serialitzable