Objeto objeto integrado

Objeto HttpResponse

http Objeto de mensaje de respuesta

Herencia

#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 para crear 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;

Atributos de miembros

statusCode

Entero, consulta y establece el estado de retorno del mensaje de respuesta

1
Integer HttpResponse.statusCode;

statusMessage

Cadena, consulta y configura el mensaje de retorno del mensaje de respuesta.

1
String HttpResponse.statusMessage;

cookies

NArray, devuelve el mensaje actual HttpCookie Lista 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 mensaje http El contenedor del encabezado del mensaje, atributo de solo lectura

1
readonly HttpCollection HttpResponse.headers;

keepAlive

Booleano, consulta y establece si quieres mantener la conexión.

1
Boolean HttpResponse.keepAlive;

upgrade

Booleano, consulta y establece si se trata de un acuerdo 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;

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

String, 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á datos diferentes según el tipo de contenido, cuando es texto, devuelve el texto, que es json Al regresar json, Otras veces vuelven a binario

1
readonly Value HttpResponse.data;

body

SeekableStream, El 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, Consultar el objeto de flujo cuando el mensaje readFrom

1
readonly Stream HttpResponse.stream;

lastError

Cadena, consulta y configuración del ú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, especifique el estado de retorno del mensaje de respuesta
  • statusMessage: Cadena, especifique el mensaje de retorno del mensaje de respuesta
  • headers: Objeto, especifique 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, especifique el estado de retorno del mensaje de respuesta
  • headers: Objeto, especifique el encabezado de respuesta agregado al mensaje de respuesta

addCookie

Agrega uno a las cookies HttpCookie Objeto

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, especifique el estado de devolución del mensaje de respuesta, el estado aceptado es: 301, 302, 307
  • url: Cadena, dirección redirigida

sendHeader

Enviar solo formato http Dirígete al objeto de flujo dado

1
HttpResponse.sendHeader(Stream stm) async;

Parámetros de llamada:

  • stm: Stream, Especifique el objeto de flujo para recibir mensajes formateados

hasHeader

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

1
Boolean HttpResponse.hasHeader(String name);

Parámetros de llamada:

  • name: Cadena, especifique el valor de la clave a verificar

Devolver resultado:

  • Boolean, Devuelve si existe el valor de la clave

firstHeader

Consultar el primer encabezado de mensaje del valor clave especificado

1
String HttpResponse.firstHeader(String name);

Parámetros de llamada:

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

Devolver resultado:

  • 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 de clave que se consultará, pase una cadena vacía para devolver el resultado de todos los valores de clave

Devolver resultado:

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

addHeader

Agregar un encabezado de mensaje, agregar datos no modifica el encabezado del mensaje del valor clave existente

1
HttpResponse.addHeader(Object map);

Parámetros de llamada:

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

Agregar un conjunto de encabezados de mensaje con un nombre específico, agregar datos no modifica los encabezados de mensaje del valor clave existente

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

Parámetros de llamada:

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

Agregar un encabezado de mensaje, agregar datos no modifica el encabezado del mensaje del valor clave existente

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

Parámetros de llamada:

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

setHeader

Establecer un encabezado de mensaje, los datos de configuración modificarán el primer valor correspondiente al valor clave y borrarán los encabezados de mensaje restantes con el mismo valor clave

1
HttpResponse.setHeader(Object map);

Parámetros de llamada:

  • map: Objeto, especifique el diccionario de datos clave-valor que se establecerá

Establezca un conjunto de encabezados de mensaje con un nombre específico, los datos de configuración modificarán el valor correspondiente al valor clave y borrarán el resto de los encabezados del mensaje con el mismo valor clave

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

Parámetros de llamada:

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

Establecer un encabezado de mensaje, los datos de configuración modificarán el primer valor correspondiente al valor clave y borrarán los encabezados de mensaje restantes con el mismo valor clave

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

Parámetros de llamada:

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

removeHeader

Eliminar todos los encabezados de mensaje del valor clave especificado

1
HttpResponse.removeHeader(String name);

Parámetros de llamada:

  • name: Cadena, especifique el valor de la clave que se eliminará

read

Lea los datos del tamaño especificado de la secuencia, este método es el alias del método de cuerpo correspondiente

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

Parámetros de llamada:

  • bytes: Entero, especifique la cantidad de datos que se leerán, el valor predeterminado es leer un bloque de datos de tamaño aleatorio, el tamaño de los datos leídos depende del dispositivo

Devolver resultado:

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

readAll

Leer todos los datos restantes de la secuencia, este método es un alias del método correspondiente de body

1
Buffer HttpResponse.readAll() async;

Devolver resultado:

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

write

Escribe los datos dados, este método es el alias del método de cuerpo correspondiente.

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

Devolver resultado:

  • Value, Este método no devolverá datos

Analizar los datos del mensaje en codificación JSON

1
Value HttpResponse.json();

Devolver resultado:

  • Value, Devuelve el resultado analizado

pack

por msgpack Codificar para escribir los datos dados

1
Value HttpResponse.pack(Value data);

Parámetros de llamada:

  • data: Valor, dados los datos a escribir

Devolver resultado:

  • Value, Este método no devolverá datos

por msgpack Codificar y analizar los datos del mensaje

1
Value HttpResponse.pack();

Devolver resultado:

  • Value, Devuelve el resultado analizado

end

Establecer el final del procesamiento del mensaje actual,Chain El procesador no continúa transacciones posteriores

1
HttpResponse.end();

isEnded

Consultar si el mensaje actual ha terminado

1
Boolean HttpResponse.isEnded();

Devolver resultado:

  • Boolean, Devuelve verdadero al final

clear

Borrar el contenido del mensaje

1
HttpResponse.clear();

sendTo

Envía un mensaje formateado al objeto de transmisión dado

1
HttpResponse.sendTo(Stream stm) async;

Parámetros de llamada:

  • stm: Stream, Especifique el objeto de flujo para recibir mensajes formateados

readFrom

Leer el mensaje formateado del objeto de flujo de caché dado y analizar el objeto de relleno

1
HttpResponse.readFrom(Stream stm) async;

Parámetros de llamada:

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

toString

Devuelve la representación en cadena del objeto, generalmente devuelve "[Native Object]", el objeto se puede volver a implementar de acuerdo con sus propias características

1
String HttpResponse.toString();

Devolver resultado:

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

toJSON

Devuelve la representación en formato JSON del objeto, generalmente devuelve una colección de atributos legibles definidos por el objeto

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

Parámetros de llamada:

  • key: Cadena, sin usar

Devolver resultado:

  • Value, Devuelve un valor que contiene JSON serializable