Obxecto HttpRequest
http Solicitar obxecto de mensaxe
Herdanza
Construtor
HttpRequest
HttpRequest constructor para crear un novo obxecto HttpRequest
1new HttpRequest();
constante
TEXT
Especifique o tipo de mensaxe 1, que representa un tipo de texto
1const HttpRequest.TEXT = 1;
BINARY
Especifique o tipo de mensaxe 2, que representa un tipo binario
1const HttpRequest.BINARY = 2;
Atributos dos membros
response
HttpResponse, Obter un obxecto de mensaxe de resposta
1readonly HttpResponse HttpRequest.response;
method
Cadea, consulta e método de solicitude de conxunto
1String HttpRequest.method;
address
Cadea, consulta e configura o enderezo da solicitude
1String HttpRequest.address;
queryString
Cadea, consulta e cadea de consulta de solicitude
1String HttpRequest.queryString;
cookies
HttpCollection, Obter o contedor que contén as cookies de mensaxes
1readonly HttpCollection HttpRequest.cookies;
form
HttpCollection, Obter o contedor que contén o formulario de mensaxe
1readonly HttpCollection HttpRequest.form;
query
HttpCollection, Obter o contedor que contén a consulta de mensaxes
1readonly HttpCollection HttpRequest.query;
protocol
Cadea, información da versión do protocolo, o formato permitido é: HTTP /#.#
1String HttpRequest.protocol;
headers
HttpCollection, Incluído na mensaxe http O contedor do encabezado da mensaxe, atributo de só lectura
1readonly HttpCollection HttpRequest.headers;
keepAlive
Booleano, consulta e define se se mantén a conexión
1Boolean HttpRequest.keepAlive;
upgrade
Booleano, consulta e define se se trata dun acordo de actualización
1Boolean HttpRequest.upgrade;
maxHeadersCount
Entero, consulta e define o número máximo de cabeceiras de solicitude, o predeterminado é 128
1Integer HttpRequest.maxHeadersCount;
maxBodySize
Entero, consulta e define o tamaño máximo do corpo, en MB, o predeterminado é 64
1Integer HttpRequest.maxBodySize;
socket
Stream, Consulte o socket de orixe do obxecto actual
1readonly Stream HttpRequest.socket;
value
Cadea, o contido básico da mensaxe
1String HttpRequest.value;
params
NArray, os parámetros básicos da mensaxe
1readonly NArray HttpRequest.params;
type
Entero, tipo de mensaxe
1Integer HttpRequest.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
1readonly Value HttpRequest.data;
body
SeekableStream, O obxecto de fluxo que contén a parte de datos da mensaxe
1SeekableStream HttpRequest.body;
length
Longo, a lonxitude da parte de datos da mensaxe
1readonly Long HttpRequest.length;
stream
Stream, Consulte o obxecto de transmisión cando a mensaxe lea De
1readonly Stream HttpRequest.stream;
lastError
Cadea, consulta e configura o último erro do procesamento de mensaxes
1String HttpRequest.lastError;
Función de membro
hasHeader
Comprobe se hai unha cabeceira de mensaxe co valor da clave especificado
1Boolean HttpRequest.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
1String HttpRequest.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
1NObject HttpRequest.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
1HttpRequest.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
2HttpRequest.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
2HttpRequest.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
1HttpRequest.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
2HttpRequest.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
2HttpRequest.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
1HttpRequest.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
1Buffer HttpRequest.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
1Buffer HttpRequest.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
1HttpRequest.write(Buffer data) async;
Parámetros de chamada:
- data: Buffer, Dados os datos a escribir
json
Escribe os datos dados na codificación JSON
1Value HttpRequest.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
1Value HttpRequest.json();
Resultado de volta:
- Value, Devolve o resultado analizado
pack
por msgpack Codificar para escribir os datos dados
1Value HttpRequest.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
1Value HttpRequest.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
1HttpRequest.end();
isEnded
Consulta se rematou a mensaxe actual
1Boolean HttpRequest.isEnded();
Resultado de volta:
- Boolean, Volve verdadeiro ao final
clear
Limpa o contido da mensaxe
1HttpRequest.clear();
sendTo
Envía unha mensaxe formatada ao obxecto de fluxo dado
1HttpRequest.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
1HttpRequest.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
1String HttpRequest.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
1Value HttpRequest.toJSON(String key = "");
Parámetros de chamada:
- key: Cadea, sen usar
Resultado de volta:
- Value, Devolve un valor que contén JSON serializable