Objecte objecte incorporat
  1. portada
  2. objectes incorporats
  3. ObjectHttpResponse

ObjectHttpResponse

HttpResponse és un objecte de resposta HTTP, utilitzantHttpRequest.responseL'objecte completa la resposta de dades del servidor HTTP, o béhttp.requestSol·licita les dades de resposta retornades del servidor

L'exemple següent mostra com fer-hohttp.ServerS'utilitza, el codi d'exemple és el següent:

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

relació hereditària

%0 object object toString() toJSON() Message Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() object->Message HttpMessage HttpMessage protocol headers keepAlive upgrade maxHeadersCount maxHeaderSize maxBodySize socket hasHeader() firstHeader() allHeader() addHeader() setHeader() removeHeader() Message->HttpMessage HttpResponse HttpResponse new HttpResponse() statusCode statusMessage status ok cookies writeHead() addCookie() redirect() sendHeader() HttpMessage->HttpResponse

Constructor

HttpResponse

El constructor HttpResponse, crea 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;

propietats dels membres

statusCode

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

1
Integer HttpResponse.statusCode;

statusMessage

Encadena, consulta i configura el missatge de retorn del missatge de resposta

1
String HttpResponse.statusMessage;

status

Enter, consulta i defineix l'estat de retorn del missatge de resposta, equivalent a statusCode

1
Integer HttpResponse.status;

ok

Booleà, consulta si la resposta actual és normal

1
readonly Boolean HttpResponse.ok;

cookies

NArray, retorna el missatge actualHttpCookiellista d'objectes

1
readonly NArray HttpResponse.cookies;

protocol

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

1
String HttpResponse.protocol;

headers

HttpCollection, inclòs al missatgehttpContenidor per a les capçaleres dels missatges, propietat de només lectura

1
readonly HttpCollection HttpResponse.headers;

keepAlive

Booleà, consulteu i definiu si voleu mantenir la connexió

1
Boolean HttpResponse.keepAlive;

upgrade

Boolean, consulteu i configureu si es tracta d'un protocol d'actualització

1
Boolean HttpResponse.upgrade;

maxHeadersCount

Enter, consulteu i estableixi el nombre màxim de capçaleres de sol·licitud, el valor predeterminat és 128

1
Integer HttpResponse.maxHeadersCount;

maxHeaderSize

Enter, consulteu i estableixi la longitud màxima de la capçalera de la sol·licitud, el valor per defecte és 8192

1
Integer HttpResponse.maxHeaderSize;

maxBodySize

Enter, consulteu i configureu la mida màxima del cos en MB, el valor predeterminat és 64

1
Integer HttpResponse.maxBodySize;

socket

Stream, Consulta el sòcol d'origen 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

Sencer, 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, es retornarà el text.jsontornar quanjson, en cas contrari, retorna binari

1
readonly Value HttpResponse.data;

body

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

1
SeekableStream HttpResponse.body;

length

Long, la longitud de la part de dades del missatge

1
readonly Long HttpResponse.length;

stream

Stream, l'objecte de flux quan es consulta el missatge readFrom

1
readonly Stream HttpResponse.stream;

lastError

Encadena, consulta i defineix l'últim error de processament del missatge

1
String HttpResponse.lastError;

funció de membre

writeHead

Definiu l'estat de devolució del missatge de resposta, retorneu el missatge i afegiu la capçalera de resposta

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

Paràmetres de trucada:

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

Definiu l'estat de devolució del missatge de resposta, retorneu el missatge i afegiu la capçalera de resposta

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

Paràmetres de trucada:

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

addCookie

Afegiu-ne un a les galetesHttpCookieobjecte

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, especifica l'estat de retorn del missatge de resposta, l'estat acceptat és: 301, 302, 307
  • url: Cadena, adreça redirigida

sendHeader

Envia només amb formathttpDirigiu-vos a l'objecte de flux donat

1
HttpResponse.sendHeader(Stream stm) async;

Paràmetres de trucada:

  • stm:Stream, especifica l'objecte de flux que rep el missatge amb format

hasHeader

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

1
Boolean HttpResponse.hasHeader(String name);

Paràmetres de trucada:

  • name: Cadena, especifica el valor de la clau que cal comprovar

Resultats 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 de la clau que s'ha de consultar

Resultats de retorn:

  • String, retorna el valor corresponent al valor de la clau, si no existeix, retorna sense definir

allHeader

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

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

Paràmetres de trucada:

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

Resultats de retorn:

  • NObject, retorna una matriu de tots els valors corresponents al valor de la clau. Si les dades no existeixen, retorna null.

addHeader

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

1
HttpResponse.addHeader(Object map);

Paràmetres de trucada:

  • map: Objecte, especifica el diccionari de dades clau-valor que cal afegir

Afegeix un conjunt de capçaleres amb el nom especificat. Afegir dades no modifica les capçaleres dels valors de clau existents.

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

Paràmetres de trucada:

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

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

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

Paràmetres de trucada:

  • name: Cadena, especifica el valor de la clau que cal afegir
  • value: Cadena, especifiqueu les dades a afegir

setHeader

Estableix una capçalera de missatge. Si estableixes les dades, es modificarà el primer valor corresponent al valor de la clau i esborrarà les capçaleres de missatge restants amb el mateix valor de clau.

1
HttpResponse.setHeader(Object map);

Paràmetres de trucada:

  • map: Objecte, especifica el diccionari de dades clau-valor que s'ha d'establir

Estableix un conjunt de capçaleres de missatge amb el nom especificat. Si estableixes les dades, es modificarà el valor corresponent al valor de la clau i esborrarà les capçaleres de missatge restants amb el mateix valor de clau.

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor de la clau que s'ha d'establir
  • values: Matriu, especifica un conjunt de dades a establir

Estableix una capçalera de missatge. Si estableixes les dades, es modificarà el primer valor corresponent al valor de la clau i esborrarà les capçaleres de missatge restants amb el mateix valor de clau.

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

Paràmetres de trucada:

  • name: Cadena, especifiqueu el valor de la clau que s'ha d'establir
  • value: Cadena, especifiqueu les dades a establir

removeHeader

Suprimeix totes les capçaleres dels missatges amb el valor de clau especificat

1
HttpResponse.removeHeader(String name);

Paràmetres de trucada:

  • name: Cadena, especifica el valor de la clau que s'ha de suprimir

read

Llegeix dades de la mida especificada del flux. Aquest mètode és un àlies del mètode corresponent del cos.

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

Paràmetres de trucada:

  • bytes: Sencer, especifica la quantitat de dades que s'han de llegir. El valor predeterminat és llegir blocs de dades de mida aleatòria. La mida de les dades llegides depèn del dispositiu.

Resultats de retorn:

  • Buffer, retorna les dades llegides del flux. Si no hi ha dades per llegir o la connexió s'interromp, es retorna null.

readAll

Llegeix totes les dades restants del flux. Aquest mètode és un àlies del mètode corresponent de body.

1
Buffer HttpResponse.readAll() async;

Resultats de retorn:

  • Buffer, retorna les dades llegides del flux. Si no hi ha dades per llegir o la connexió s'interromp, es retorna null.

write

Escriu les dades donades. Aquest mètode és un àlies del mètode corresponent al cos.

1
HttpResponse.write(Buffer data) async;

Paràmetres de trucada:

  • data:Buffer, donades les dades a escriure

json

Escriu les dades proporcionades en codificació JSON

1
Value HttpResponse.json(Value data);

Paràmetres de trucada:

  • data: Valor, tenint en compte les dades a escriure

Resultats de retorn:

  • Value, aquest mètode no retorna dades

Analitzeu les dades del missatge com a codificació JSON

1
Value HttpResponse.json();

Resultats de retorn:

  • Value, retorna el resultat analitzat

pack

permsgpackLa codificació escriu les dades donades

1
Value HttpResponse.pack(Value data);

Paràmetres de trucada:

  • data: Valor, tenint en compte les dades a escriure

Resultats de retorn:

  • Value, aquest mètode no retorna dades

permsgpackCodificació i anàlisi de les dades del missatge

1
Value HttpResponse.pack();

Resultats de retorn:

  • Value, retorna el resultat analitzat

end

Establir el final del processament del missatge actual,ChainEl processador no continua amb les transaccions posteriors

1
HttpResponse.end();

isEnded

Consulta si el missatge actual ha acabat

1
Boolean HttpResponse.isEnded();

Resultats de retorn:

  • Boolean, torna veritable quan s'hagi acabat

clear

Esborra el contingut del missatge

1
HttpResponse.clear();

sendTo

Envia un missatge amb format a l'objecte de flux donat

1
HttpResponse.sendTo(Stream stm) async;

Paràmetres de trucada:

  • stm:Stream, especifica l'objecte de flux que rep el missatge amb format

readFrom

Llegeix el missatge amb format de l'objecte del flux de memòria cau donat i analitza l'objecte emplenat

1
HttpResponse.readFrom(Stream stm) async;

Paràmetres de trucada:

  • stm:Stream, especifica l'objecte de flux per llegir missatges amb format

toString

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

1
String HttpResponse.toString();

Resultats de retorn:

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

toJSON

Retorna una representació en format JSON de l'objecte, generalment retornant una col·lecció de propietats llegibles definides per l'objecte.

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

Paràmetres de trucada:

  • key: Corda, no utilitzada

Resultats de retorn:

  • Value, retorna un valor que conté JSON serializable
© Copyright 2012-2024 fibjs.org | Doneu-nos suport