Objeto incorporado
  1. página delantera
  2. objetos incorporados
  3. ObjetoHttpRespuesta

ObjetoHttpRespuesta

HttpResponse es un objeto de respuesta HTTP, que utilizaHttpRequest.responseEl objeto completa la respuesta de datos del servidor HTTP, ohttp.requestSolicitar datos de respuesta devueltos por el servidor

El siguiente ejemplo muestra cómohttp.ServerUtilizado en, el código de muestra es el siguiente:

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 herencia

%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

Constructor HttpResponse, crea un nuevo objeto HttpResponse

1
new HttpResponse();

constante

TEXT

Especifique el tipo de mensaje 1, que representa un tipo de texto.

1
const HttpResponse.TEXT = 1;

BINARY

Especifique el tipo de mensaje 2, que representa un tipo binario.

1
const HttpResponse.BINARY = 2;

propiedades de miembros

statusCode

Entero, consulta y establece el estado de devolución del mensaje de respuesta

1
Integer HttpResponse.statusCode;

statusMessage

Encadenar, consultar y configurar el mensaje de retorno del mensaje de respuesta

1
String HttpResponse.statusMessage;

status

Entero, consulta y establece el estado de devolución del mensaje de respuesta, equivalente a statusCode

1
Integer HttpResponse.status;

ok

Booleano, consulta si la respuesta actual es normal

1
readonly Boolean HttpResponse.ok;

cookies

NArray, devuelve el mensaje actualHttpCookielista de objetos

1
readonly NArray HttpResponse.cookies;

protocol

Cadena, información de la versión del protocolo, el formato permitido es: HTTP/#.#

1
String HttpResponse.protocol;

headers

HttpCollection, incluido en el mensajehttpContenedor para encabezados de mensajes, propiedad de solo lectura

1
readonly HttpCollection HttpResponse.headers;

keepAlive

Booleano, consulta y establece si se mantiene la conexión.

1
Boolean HttpResponse.keepAlive;

upgrade

Booleano, consulta y establece si es un protocolo de actualización

1
Boolean HttpResponse.upgrade;

maxHeadersCount

Entero, consulta y establece el número máximo de encabezados de solicitud, el valor predeterminado es 128

1
Integer HttpResponse.maxHeadersCount;

maxHeaderSize

Entero, consulta y establece la longitud máxima del encabezado de solicitud, el valor predeterminado es 8192

1
Integer HttpResponse.maxHeaderSize;

maxBodySize

Entero, consulta y establece el tamaño máximo del cuerpo en MB, el valor predeterminado es 64

1
Integer HttpResponse.maxBodySize;

socket

Stream, Consulta el socket de origen del objeto actual.

1
readonly Stream HttpResponse.socket;

value

Cadena, el contenido básico del mensaje.

1
String HttpResponse.value;

params

NArray, los parámetros básicos del mensaje.

1
readonly NArray HttpResponse.params;

type

Entero, tipo de mensaje

1
Integer HttpResponse.type;

data

Valor, consulta los datos del mensaje. Este atributo devolverá diferentes datos según el tipo de contenido. Cuando sea texto, se devolverá el texto.jsonregresar cuandojson, de lo contrario devuelve binario

1
readonly Value HttpResponse.data;

body

SeekableStream, un objeto de flujo que contiene la parte de datos del mensaje

1
SeekableStream HttpResponse.body;

length

Long, la longitud de la parte de datos del mensaje.

1
readonly Long HttpResponse.length;

stream

Stream, el objeto de flujo al consultar el mensaje readFrom

1
readonly Stream HttpResponse.stream;

lastError

Cadena, consulta y establece el último error de procesamiento de mensajes

1
String HttpResponse.lastError;

función miembro

writeHead

Establezca el estado de devolución del mensaje de respuesta, devuelva el mensaje y agregue el encabezado de respuesta

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

Parámetros de llamada:

  • statusCode: Entero, especifica el estado de devolución del mensaje de respuesta.
  • statusMessage: Cadena, especifica el mensaje de retorno del mensaje de respuesta.
  • headers: Objeto, especifica el encabezado de respuesta agregado al mensaje de respuesta.

Establezca el estado de devolución del mensaje de respuesta, devuelva el mensaje y agregue el encabezado de respuesta

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

Parámetros de llamada:

  • statusCode: Entero, especifica el estado de devolución del mensaje de respuesta.
  • headers: Objeto, especifica el encabezado de respuesta agregado al mensaje de respuesta.

addCookie

Agrega uno a las cookiesHttpCookieobjeto

1
HttpResponse.addCookie(HttpCookie cookie);

Parámetros de llamada:

redirect

Enviar redireccionamiento al cliente

1
HttpResponse.redirect(String url);

Parámetros de llamada:

  • url: Cadena, dirección redirigida

Enviar redireccionamiento al cliente

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

Parámetros de llamada:

  • statusCode: Entero, especifica el estado de devolución del mensaje de respuesta, el estado aceptado es: 301, 302, 307
  • url: Cadena, dirección redirigida

sendHeader

Enviar solo formateadohttpDirígete al objeto de flujo dado

1
HttpResponse.sendHeader(Stream stm) async;

Parámetros de llamada:

  • stm:Stream, especifica el objeto de flujo que recibe el mensaje formateado

hasHeader

Compruebe si hay un encabezado de mensaje con el valor clave especificado

1
Boolean HttpResponse.hasHeader(String name);

Parámetros de llamada:

  • name: Cadena, especifica el valor clave que se va a comprobar

Resultados de devolución:

  • Boolean, devuelve si el valor clave existe

firstHeader

Consultar el primer encabezado del mensaje del valor clave especificado

1
String HttpResponse.firstHeader(String name);

Parámetros de llamada:

  • name: Cadena, especifique el valor clave que se consultará

Resultados de devolución:

  • String, devuelve el valor correspondiente al valor clave, si no existe, devuelve indefinido

allHeader

Consultar todos los encabezados de mensajes del valor clave especificado

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

Parámetros de llamada:

  • name: Cadena, especifique el valor clave que se consultará, pase una cadena vacía para devolver los resultados de todos los valores clave

Resultados de devolución:

  • NObject, Devuelve una matriz de todos los valores correspondientes al valor clave. Si los datos no existen, devuelve nulo.

addHeader

Agregue un encabezado de mensaje, agregue datos y no modifique el encabezado del mensaje del valor clave existente

1
HttpResponse.addHeader(Object map);

Parámetros de llamada:

  • map: Objeto, especifica el diccionario de datos clave-valor que se agregará

Agrega un conjunto de encabezados con el nombre especificado. Agregar datos no modifica los encabezados de los valores clave existentes.

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

Parámetros de llamada:

  • name: Cadena, especifica el valor clave que se agregará
  • values: Matriz, especifica un conjunto de datos que se agregarán

Agregue un encabezado de mensaje, agregue datos y no modifique el encabezado del mensaje del valor clave existente

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

Parámetros de llamada:

  • name: Cadena, especifica el valor clave que se agregará
  • value: Cadena, especifica los datos que se agregarán

setHeader

Establecer un encabezado de mensaje. Al configurar los datos se modificará el primer valor correspondiente al valor clave y se borrarán los encabezados de mensajes restantes con el mismo valor clave.

1
HttpResponse.setHeader(Object map);

Parámetros de llamada:

  • map: Objeto, especifica el diccionario de datos clave-valor que se configurará

Establezca un conjunto de encabezados de mensajes con el nombre especificado. La configuración de los datos modificará el valor correspondiente al valor clave y borrará los encabezados de mensajes restantes con el mismo valor clave.

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

Parámetros de llamada:

  • name: Cadena, especifique el valor clave que se establecerá
  • values: Matriz, especifica un conjunto de datos que se establecerán

Establecer un encabezado de mensaje. Al configurar los datos se modificará el primer valor correspondiente al valor clave y se borrarán los encabezados de mensajes restantes con el mismo valor clave.

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

Parámetros de llamada:

  • name: Cadena, especifique el valor clave que se establecerá
  • value: Cadena, especifique los datos que se establecerán

removeHeader

Eliminar todos los encabezados de mensajes con el valor clave especificado

1
HttpResponse.removeHeader(String name);

Parámetros de llamada:

  • name: Cadena, especifica el valor clave que se eliminará

read

Lee datos de tamaño especificado de la secuencia. Este método es un alias del método correspondiente del cuerpo.

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

Parámetros de llamada:

  • bytes: Entero, especifica la cantidad de datos que se leerán. El valor predeterminado es leer bloques de datos de tamaño aleatorio. El tamaño de los datos leídos depende del dispositivo.

Resultados de devolución:

  • Buffer, devuelve los datos leídos de la secuencia. Si no hay datos para leer o la conexión se interrumpe, se devuelve nulo.

readAll

Lea todos los datos restantes de la secuencia. Este método es un alias del método correspondiente del cuerpo.

1
Buffer HttpResponse.readAll() async;

Resultados de devolución:

  • Buffer, devuelve los datos leídos de la secuencia. Si no hay datos para leer o la conexión se interrumpe, se devuelve nulo.

write

Escribe los datos dados. Este método es un alias del método correspondiente en el cuerpo.

1
HttpResponse.write(Buffer data) async;

Parámetros de llamada:

  • data:Buffer, dados los datos a escribir

json

Escribe los datos dados en codificación JSON.

1
Value HttpResponse.json(Value data);

Parámetros de llamada:

  • data: Valor, dados los datos a escribir

Resultados de devolución:

  • Value, este método no devuelve datos

Analizar los datos del mensaje como codificación JSON.

1
Value HttpResponse.json();

Resultados de devolución:

  • Value, devuelve el resultado analizado

pack

pormsgpackLa codificación escribe los datos dados.

1
Value HttpResponse.pack(Value data);

Parámetros de llamada:

  • data: Valor, dados los datos a escribir

Resultados de devolución:

  • Value, este método no devuelve datos

pormsgpackCodificar y analizar los datos del mensaje.

1
Value HttpResponse.pack();

Resultados de devolución:

  • Value, devuelve el resultado analizado

end

Establecer el final del procesamiento del mensaje actual,ChainEl procesador no continúa con transacciones posteriores.

1
HttpResponse.end();

isEnded

Consultar si el mensaje actual ha finalizado

1
Boolean HttpResponse.isEnded();

Resultados de devolución:

  • Boolean, devuelve verdadero cuando termina

clear

Borrar contenido del mensaje

1
HttpResponse.clear();

sendTo

Envía un mensaje formateado al objeto de flujo dado

1
HttpResponse.sendTo(Stream stm) async;

Parámetros de llamada:

  • stm:Stream, especifica el objeto de flujo que recibe el mensaje formateado

readFrom

Lee el mensaje formateado del objeto de flujo de caché dado y analiza el objeto poblado

1
HttpResponse.readFrom(Stream stm) async;

Parámetros de llamada:

  • stm:Stream, especifica el objeto de flujo para leer mensajes formateados.

toString

Devuelve la representación de cadena del objeto. Generalmente, se devuelve "[Objeto nativo]". El objeto se puede volver a implementar de acuerdo con sus propias características.

1
String HttpResponse.toString();

Resultados de devolución:

  • String, devuelve la representación de cadena del objeto

toJSON

Devuelve una representación en formato JSON del objeto, que generalmente devuelve una colección de propiedades legibles definidas por el objeto.

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

Parámetros de llamada:

  • key: Cadena, no utilizada

Resultados de devolución:

  • Value, devuelve un valor que contiene JSON serializable
© Copyright 2012-2024 fibjs.org | Apóyanos