Obxecto incorporado

Obxecto HttpResponse

http Obxecto de mensaxe de resposta

Herdanza

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

Construtor

HttpResponse

Constructor de HttpResponse para crear 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;

Atributos dos membros

statusCode

Entero, consulta e configura o estado de devolución da mensaxe de resposta

1
Integer HttpResponse.statusCode;

statusMessage

Cadea, consulta e configura a mensaxe de devolución da mensaxe de resposta

1
String HttpResponse.statusMessage;

cookies

NArray, devolve a mensaxe actual HttpCookie Lista de obxectos

1
readonly NArray HttpResponse.cookies;

protocol

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

1
String HttpResponse.protocol;

headers

HttpCollection, Incluído na mensaxe http O contedor do encabezado da mensaxe, atributo de só lectura

1
readonly HttpCollection HttpResponse.headers;

keepAlive

Booleano, consulta e define se se mantén a conexión

1
Boolean HttpResponse.keepAlive;

upgrade

Booleano, consulta e define se se trata dun acordo de actualización

1
Boolean HttpResponse.upgrade;

maxHeadersCount

Entero, consulta e define o número máximo de cabeceiras de solicitude, o predeterminado é 128

1
Integer HttpResponse.maxHeadersCount;

maxBodySize

Entero, consulta e define o tamaño máximo do corpo, en MB, o predeterminado é 64

1
Integer HttpResponse.maxBodySize;

socket

Stream, Consulte o socket de orixe do obxecto actual

1
readonly Stream HttpResponse.socket;

value

Cadea, o contido básico da mensaxe

1
String HttpResponse.value;

params

NArray, os parámetros básicos da mensaxe

1
readonly NArray HttpResponse.params;

type

Entero, tipo de mensaxe

1
Integer HttpResponse.type;

data

Valor, consulta os datos da mensaxe, este atributo devolve datos diferentes segundo o tipo de contido, cando é texto, devolve o texto, que é json Ao volver json, Outras veces volven ao binario

1
readonly Value HttpResponse.data;

body

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

1
SeekableStream HttpResponse.body;

length

Longo, a lonxitude da parte de datos da mensaxe

1
readonly Long HttpResponse.length;

stream

Stream, Consulte o obxecto de transmisión cando a mensaxe lea De

1
readonly Stream HttpResponse.stream;

lastError

Cadea, consulta e configura o último erro do procesamento de mensaxes

1
String HttpResponse.lastError;

Función de membro

writeHead

Configure o estado de devolución da mensaxe de resposta, devolva a mensaxe e engada o encabezado da resposta

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

Parámetros de chamada:

  • statusCode: Enteiro, especifique o estado de retorno da mensaxe de resposta
  • statusMessage: Cadea, especifica a mensaxe de devolución da mensaxe de resposta
  • headers: Obxecto, especifica o encabezado de resposta engadido á mensaxe de resposta

Configure o estado de devolución da mensaxe de resposta, devolva a mensaxe e engada o encabezado da resposta

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

Parámetros de chamada:

  • statusCode: Enteiro, especifique o estado de retorno da mensaxe de resposta
  • headers: Obxecto, especifica o encabezado de resposta engadido á mensaxe de resposta

addCookie

Engade unha ás cookies HttpCookie Obxecto

1
HttpResponse.addCookie(HttpCookie cookie);

Parámetros de chamada:


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 2
HttpResponse.redirect(Integer statusCode, String url);

Parámetros de chamada:

  • statusCode: Enteiro, especifique o estado de devolución da mensaxe de resposta, o estado aceptado é: 301, 302, 307
  • url: Cadea, enderezo redirixido

sendHeader

Enviar só formato http Diríxete ao obxecto de fluxo indicado

1
HttpResponse.sendHeader(Stream stm) async;

Parámetros de chamada:

  • stm: Stream, Especifique o obxecto de transmisión para recibir mensaxes formatadas

hasHeader

Comprobe se hai unha cabeceira de mensaxe co valor da clave especificado

1
Boolean HttpResponse.hasHeader(String name);

Parámetros de chamada:

  • name: Cadea, especifique o valor clave que se comprobará

Resultado de volta:

  • Boolean, Devolve se existe o valor clave

firstHeader

Consulte a primeira cabeceira da mensaxe do valor da clave especificado

1
String HttpResponse.firstHeader(String name);

Parámetros de chamada:

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

Resultado de volta:

  • String, Devolve o valor correspondente ao valor clave, se non existe, devolve indefinido

allHeader

Consulte todas as cabeceiras das mensaxes do valor da clave especificado

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

Parámetros de chamada:

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

Resultado de volta:

  • NObject, Devolve unha matriz de todos os valores correspondentes ao valor clave, se os datos non existen, devolve nulo

addHeader

Engade unha cabeceira de mensaxe, engadindo datos non modifica a cabeceira da mensaxe do valor da chave existente

1
HttpResponse.addHeader(Object map);

Parámetros de chamada:

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

Engade un conxunto de cabeceiras de mensaxes cun nome especificado, engadindo datos non modifica as cabeceiras da mensaxe do valor da chave existente

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

Parámetros de chamada:

  • name: Cadea, especifique o valor clave que se vai engadir
  • values: Array, especifique un conxunto de datos que se van engadir

Engade unha cabeceira de mensaxe, engadindo datos non modifica a cabeceira da mensaxe do valor da chave existente

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

Parámetros de chamada:

  • name: Cadea, especifique o valor clave que se vai engadir
  • value: Cadea, especifique os datos que se van engadir

setHeader

Establece un encabezado de mensaxe, os datos de configuración modificarán o primeiro valor correspondente ao valor da clave e limparán os encabezados de mensaxe restantes co mesmo valor de clave

1
HttpResponse.setHeader(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique o dicionario de datos clave-valor que se vai establecer

Establece un conxunto de cabeceiras de mensaxes cun nome especificado, os datos de configuración modificarán o valor correspondente ao valor da clave e limparán o resto das cabeceiras da mensaxe co mesmo valor de clave

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

Parámetros de chamada:

  • name: Cadea, especifica o valor clave que se definirá
  • values: Matriz, especifique un conxunto de datos que se vai establecer

Establece un encabezado de mensaxe, os datos de configuración modificarán o primeiro valor correspondente ao valor da clave e limparán os encabezados de mensaxe restantes co mesmo valor de clave

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

Parámetros de chamada:

  • name: Cadea, especifica o valor clave que se definirá
  • value: Cadea, especifique os datos a configurar

removeHeader

Elimina todas as cabeceiras das mensaxes do valor da clave especificado

1
HttpResponse.removeHeader(String name);

Parámetros de chamada:

  • name: Cadea, especifique o valor clave que se vai eliminar

read

Lea os datos do tamaño especificado do fluxo, este método é o alias do método de corpo correspondente

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

Parámetros de chamada:

  • bytes: Enteiro, especifique a cantidade de datos que se vai ler, o predeterminado é ler un bloque de datos de tamaño aleatorio, o tamaño dos datos lidos depende do dispositivo

Resultado de volta:

  • Buffer, Devolve os datos lidos do fluxo, se non hai datos para ler ou se interrompe a conexión, devolve nulo

readAll

Lea todos os datos restantes do fluxo, este método é un alias do método de corpo correspondente

1
Buffer HttpResponse.readAll() async;

Resultado de volta:

  • Buffer, Devolve os datos lidos do fluxo, se non hai datos para ler ou se interrompe a conexión, devolve nulo

write

Escribe os datos dados, este método é o alias do método de corpo correspondente

1
HttpResponse.write(Buffer data) async;

Parámetros de chamada:

  • data: Buffer, Dados os datos a escribir

json

Escribe os datos dados na codificación JSON

1
Value HttpResponse.json(Value data);

Parámetros de chamada:

  • data: Valor, dados os datos que se van escribir

Resultado de volta:

  • Value, Este método non devolverá datos

Analice os datos da mensaxe na codificación JSON

1
Value HttpResponse.json();

Resultado de volta:

  • Value, Devolve o resultado analizado

pack

por msgpack Codificar para escribir os datos dados

1
Value HttpResponse.pack(Value data);

Parámetros de chamada:

  • data: Valor, dados os datos que se van escribir

Resultado de volta:

  • Value, Este método non devolverá datos

por msgpack Codificación e análise dos datos da mensaxe

1
Value HttpResponse.pack();

Resultado de volta:

  • Value, Devolve o resultado analizado

end

Defina o final do procesamento de mensaxes actual,Chain O procesador non continúa coas transaccións posteriores

1
HttpResponse.end();

isEnded

Consulta se rematou a mensaxe actual

1
Boolean HttpResponse.isEnded();

Resultado de volta:

  • Boolean, Volve verdadeiro ao final

clear

Limpa o contido da mensaxe

1
HttpResponse.clear();

sendTo

Envía unha mensaxe formatada ao obxecto de fluxo dado

1
HttpResponse.sendTo(Stream stm) async;

Parámetros de chamada:

  • stm: Stream, Especifique o obxecto de transmisión para recibir mensaxes formatadas

readFrom

Le a mensaxe formatada desde o obxecto de fluxo de caché dado e analiza o obxecto de recheo

1
HttpResponse.readFrom(Stream stm) async;

Parámetros de chamada:

  • stm: Stream, Especifique o obxecto de fluxo para ler as mensaxes formatadas

toString

Devolve a representación de cadea do obxecto, xeralmente devolve "[Obxecto nativo]", o obxecto pode reimplementarse segundo as súas propias características

1
String HttpResponse.toString();

Resultado de volta:

  • String, Devolve a representación de cadea do obxecto

toJSON

Devolve a representación en formato JSON do obxecto, xeralmente devolve unha colección de atributos lexibles definidos polo obxecto

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

Parámetros de chamada:

  • key: Cadea, sen usar

Resultado de volta:

  • Value, Devolve un valor que contén JSON serializable