ObjectHttpResponse

HttpResponse é un obxecto de resposta HTTP que utilizaHttpRequest.responseO obxecto completa a resposta de datos do servidor HTTP ouhttp.requestSolicitar datos de resposta devoltos polo servidor

O seguinte exemplo mostra comohttp.ServerUsado en, o código de mostra é o seguinte:

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ón de herdanza

Construtor

HttpResponse

Construtor HttpResponse, crea un novo obxecto HttpResponse

1
new HttpResponse();

constante

TEXT

Especifique o tipo de mensaxe 1, que representa un tipo de texto

1
const HttpResponse.TEXT = 1;

BINARY

Especifique o tipo de mensaxe 2, que representa un tipo binario

1
const HttpResponse.BINARY = 2;

propiedades dos membros

statusCode

Enteiro, consulta e establece o estado de retorno da mensaxe de resposta

1Integer HttpResponse.statusCode;

statusMessage

Cadena, consulta e establece a mensaxe de retorno da mensaxe de resposta

1
String HttpResponse.statusMessage;

status

Enteiro, consulta e establece o estado de retorno da mensaxe de resposta, equivalente a statusCode

1Integer HttpResponse.status;

ok

Booleano, consulta se a resposta actual é normal

1
readonly Boolean HttpResponse.ok;

cookies

NArray, devolve a mensaxe actualHttpCookielista de obxectos

1readonly NArray HttpResponse.cookies;

protocol

A cadea, a información da versión do protocolo, o formato permitido é: HTTP/#.#

1
String HttpResponse.protocol;

headers

HttpCollection, incluído na mensaxehttpContedor para cabeceiras de mensaxes, propiedade de só lectura

1readonly HttpCollection HttpResponse.headers;

keepAlive

Booleano, consulta e establece se queres manter a conexión

1
Boolean HttpResponse.keepAlive;

upgrade

Booleano, consulta e establece se é un protocolo de actualización

1
Boolean HttpResponse.upgrade;

maxHeadersCount

Número enteiro, consulta e establece o número máximo de cabeceiras de solicitude, o valor predeterminado é 128

1Integer HttpResponse.maxHeadersCount;

maxHeaderSize

Número enteiro, consulta e establece a lonxitude máxima da cabeceira da solicitude, o valor predeterminado é 8192

1Integer HttpResponse.maxHeaderSize;

maxBodySize

Enteiro, consulta e establece o tamaño máximo do corpo en MB, o valor predeterminado é 64

1Integer HttpResponse.maxBodySize;

socket

Stream, Consulta o socket de orixe do obxecto actual

1readonly Stream HttpResponse.socket;

value

String, o contido básico da mensaxe

1
String HttpResponse.value;

params

NArray, os parámetros básicos da mensaxe

1readonly NArray HttpResponse.params;

type

Número enteiro, tipo de mensaxe

1Integer HttpResponse.type;

data

Valor, consulta os datos da mensaxe. Este atributo devolverá datos diferentes segundo o tipo de contido. Cando sexa texto, devolverase o texto.jsonvolver candojson, se non, devolve binario

1readonly Value HttpResponse.data;

body

SeekableStream, un obxecto de fluxo que contén a parte de datos da mensaxe

1SeekableStream HttpResponse.body;

length

Long, a lonxitude da parte de datos da mensaxe

1readonly Long HttpResponse.length;

stream

Stream, o obxecto de fluxo cando se consulta a mensaxe readFrom

1readonly Stream HttpResponse.stream;

lastError

Cadena, consulta e establece o último erro de procesamento da mensaxe

1
String HttpResponse.lastError;

función de membro

writeHead

Establece o estado de devolución da mensaxe de resposta, devolve a mensaxe e engade a cabeceira de resposta

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

Parámetros de chamada:

statusCode: Número enteiro, especifica o estado de retorno da mensaxe de resposta
statusMessage: Cadea, especifica a mensaxe de retorno da mensaxe de resposta
headers: Obxecto, especifica a cabeceira de resposta engadida á mensaxe de resposta

Establece o estado de devolución da mensaxe de resposta, devolve a mensaxe e engade a cabeceira de resposta

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

Parámetros de chamada:

statusCode: Número enteiro, especifica o estado de retorno da mensaxe de resposta
headers: Obxecto, especifica a cabeceira de resposta engadida á mensaxe de resposta

addCookie

Engade un ás cookiesHttpCookieobxecto

1HttpResponse.addCookie(HttpCookie cookie);

Parámetros de chamada:

cookie:HttpCookie, especifique oHttpCookieobxecto

redirect

Enviar redirección ao cliente

1
HttpResponse.redirect(String url);

Parámetros de chamada:

url: Cadea, enderezo redirixido

Enviar redirección ao cliente

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

Parámetros de chamada:

statusCode: Enteiro, especifica o estado de retorno da mensaxe de resposta, o estado aceptado é: 301, 302, 307
url: Cadea, enderezo redirixido

sendHeader

Enviar só con formatohttpDiríxete ao obxecto de fluxo indicado

1
HttpResponse.sendHeader(Stream stm) async;

Parámetros de chamada:

stm:Stream, especifica o obxecto de fluxo que recibe a mensaxe con formato

hasHeader

Comproba se hai unha cabeceira de mensaxe co valor de clave especificado

1
Boolean HttpResponse.hasHeader(String name);

Parámetros de chamada:

name: Cadea, especifica o valor da clave que se vai comprobar

Resultados de devolución:

Boolean, devolve se o valor da chave existe

firstHeader

Consulta a primeira cabeceira da mensaxe do valor de chave especificado

1
String HttpResponse.firstHeader(String name);

Parámetros de chamada:

name: Cadea, especifique o valor da clave que se vai consultar

Resultados de devolución:

String, devolve o valor correspondente ao valor da chave, se non existe, devolve indefinido

allHeader

Consulta todas as cabeceiras das mensaxes do valor de chave especificado

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

Parámetros de chamada:

name: Cadea, especifique o valor da clave que se vai consultar, pase unha cadea baleira para devolver os resultados de todos os valores clave

Resultados de devolución:

NObject, devolve unha matriz de todos os valores correspondentes ao valor da chave. Se os datos non existen, devolve nulo.

addHeader

Engade unha cabeceira de mensaxe, engade datos e non modifique a cabeceira da mensaxe do valor da chave existente

1
HttpResponse.addHeader(Object map);

Parámetros de chamada:

map: Obxecto, especifica o dicionario de datos clave-valor que se vai engadir

Engade un conxunto de cabeceiras co nome especificado. Ao engadir datos non se modifican as cabeceiras dos valores clave existentes.

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

Parámetros de chamada:

name: Cadea, especifica o valor da chave que se vai engadir
values: Matriz, especifica un conxunto de datos a engadir

Engade unha cabeceira de mensaxe, engade datos e non modifique a cabeceira da mensaxe do valor da chave existente

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

Parámetros de chamada:

name: Cadea, especifica o valor da chave que se vai engadir
value: Cadea, especifique os datos a engadir

setHeader

Establece unha cabeceira de mensaxe. Ao configurar os datos modificarase o primeiro valor correspondente ao valor da clave e borrará as cabeceiras das mensaxes restantes co mesmo valor de chave.

1
HttpResponse.setHeader(Object map);

Parámetros de chamada:

map: Obxecto, especifica o dicionario de datos clave-valor que se vai definir

Establece un conxunto de cabeceiras de mensaxe co nome especificado. Ao configurar os datos modificarase o valor correspondente ao valor da chave e borrará as cabeceiras das mensaxes restantes co mesmo valor de chave.

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

Parámetros de chamada:

name: Cadea, especifique o valor da clave que se quere establecer
values: Matriz, especifica un conxunto de datos a definir

Establece unha cabeceira de mensaxe. Ao configurar os datos modificarase o primeiro valor correspondente ao valor da clave e borrará as cabeceiras das mensaxes restantes co mesmo valor de chave.

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

Parámetros de chamada:

name: Cadea, especifique o valor da clave que se quere establecer
value: Cadea, especifique os datos a definir

removeHeader

Elimina todas as cabeceiras das mensaxes co valor de clave especificado

1
HttpResponse.removeHeader(String name);

Parámetros de chamada:

name: Cadea, especifica o valor da clave que se vai eliminar

read

Le datos do tamaño especificado do fluxo. Este método é un alias do método correspondente do corpo.

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

Parámetros de chamada:

bytes: Número enteiro, especifica a cantidade de datos que se van ler. O valor predeterminado é ler bloques de datos de tamaño aleatorio. O tamaño dos datos lidos depende do dispositivo.

Resultados de devolución:

Buffer, devolve os datos lidos do fluxo. Se non hai datos para ler ou se interrompe a conexión, devólvese nulo.

readAll

Le todos os datos restantes do fluxo. Este método é un alias do método correspondente do corpo.

1
Buffer HttpResponse.readAll() async;

Resultados de devolución:

Buffer, devolve os datos lidos do fluxo. Se non hai datos para ler ou se interrompe a conexión, devólvese nulo.

write

Escribe os datos dados. Este método é un alias do método correspondente no corpo.

1
HttpResponse.write(Buffer data) async;

Parámetros de chamada:

data:Buffer, dados os datos a escribir

json

Escribe os datos proporcionados en codificación JSON

1Value HttpResponse.json(Value data);

Parámetros de chamada:

data: Valor, dados os datos a escribir

Resultados de devolución:

Value, este método non devolve datos

Analiza os datos da mensaxe como codificación JSON

1Value HttpResponse.json();

Resultados de devolución:

Value, devolve o resultado analizado

pack

pormsgpackA codificación escribe os datos dados

1Value HttpResponse.pack(Value data);

Parámetros de chamada:

data: Valor, dados os datos a escribir

Resultados de devolución:

Value, este método non devolve datos

pormsgpackCodificación e análise dos datos da mensaxe

1Value HttpResponse.pack();

Resultados de devolución:

Value, devolve o resultado analizado

end

Establece o final do procesamento da mensaxe actual,ChainO procesador non continúa coas transaccións posteriores

1HttpResponse.end();

isEnded

Consulta se a mensaxe actual rematou

1
Boolean HttpResponse.isEnded();

Resultados de devolución:

Boolean, devolve verdadeiro cando remate

clear

Borrar o contido da mensaxe

1HttpResponse.clear();

sendTo

Envía unha mensaxe con formato ao obxecto de fluxo indicado

1
HttpResponse.sendTo(Stream stm) async;

Parámetros de chamada:

stm:Stream, especifica o obxecto de fluxo que recibe a mensaxe con formato

readFrom

Le a mensaxe con formato do obxecto de fluxo de caché indicado e analiza o obxecto poboado

1
HttpResponse.readFrom(Stream stm) async;

Parámetros de chamada:

stm:Stream, especifica o obxecto de fluxo para ler mensaxes con formato

toString

Devolve a representación en cadea do obxecto. Polo xeral, devólvese "[Obxecto nativo]". O obxecto pódese volver implementar segundo as súas propias características.

1
String HttpResponse.toString();

Resultados de devolución:

String, devolve a representación en cadea do obxecto

toJSON

Devolve unha representación en formato JSON do obxecto, devolvendo xeralmente unha colección de propiedades lexibles definidas polo obxecto.

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

Parámetros de chamada:

key: Cadena, non usada

Resultados de devolución:

Value, devolve un valor que contén JSON serializable

Guía de desenvolvemento

Módulo básico

obxectos incorporados

módulo comunitario

ObjectHttpResponse

relación de herdanza

Construtor

HttpResponse

constante

TEXT

BINARY

propiedades dos membros

statusCode

statusMessage

status

ok

cookies

protocol

headers

keepAlive

upgrade

maxHeadersCount

maxHeaderSize

maxBodySize

socket

value

params

type

data

body

length

stream

lastError

función de membro

writeHead

addCookie

redirect

sendHeader

hasHeader

firstHeader

allHeader

addHeader

setHeader

removeHeader

read

readAll

write

json

pack

end

isEnded

clear

sendTo

readFrom

toString

toJSON