Obxecto incorporado

Obxecto HttpMessage

http Obxecto de mensaxe básico

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()] [<this>HttpMessage|protocol;headers;keepAlive;upgrade;maxHeadersCount;maxBodySize;socket|hasHeader();firstHeader();allHeader();addHeader();setHeader();removeHeader()] [<class>HttpRequest] [<class>HttpResponse] [object] <:- [Message] [Message] <:- [HttpMessage] [HttpMessage] <:- [HttpRequest] [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() HttpMessage protocol headers keepAlive upgrade maxHeadersCount maxBodySize socket hasHeader() firstHeader() allHeader() addHeader() setHeader() removeHeader() object toString() toJSON() HttpRequest HttpResponse

constante

TEXT

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

1
const HttpMessage.TEXT = 1;

BINARY

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

1
const HttpMessage.BINARY = 2;

Atributos dos membros

protocol

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

1
String HttpMessage.protocol;

headers

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

1
readonly HttpCollection HttpMessage.headers;

keepAlive

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

1
Boolean HttpMessage.keepAlive;

upgrade

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

1
Boolean HttpMessage.upgrade;

maxHeadersCount

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

1
Integer HttpMessage.maxHeadersCount;

maxBodySize

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

1
Integer HttpMessage.maxBodySize;

socket

Stream, Consulte o socket de orixe do obxecto actual

1
readonly Stream HttpMessage.socket;

value

Cadea, o contido básico da mensaxe

1
String HttpMessage.value;

params

NArray, os parámetros básicos da mensaxe

1
readonly NArray HttpMessage.params;

type

Entero, tipo de mensaxe

1
Integer HttpMessage.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 HttpMessage.data;

body

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

1
SeekableStream HttpMessage.body;

length

Longo, a lonxitude da parte de datos da mensaxe

1
readonly Long HttpMessage.length;

stream

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

1
readonly Stream HttpMessage.stream;

lastError

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

1
String HttpMessage.lastError;

Función de membro

hasHeader

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

1
Boolean HttpMessage.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 HttpMessage.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 HttpMessage.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
HttpMessage.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
HttpMessage.addHeader(String name, Array values);

Parámetros de chamada:

  • name: Cadea, especifique o valor clave que se vai engadir
  • values: Matriz, 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
HttpMessage.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
HttpMessage.setHeader(Object map);

Parámetros de chamada:

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

Estableza 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
HttpMessage.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
HttpMessage.setHeader(String name, String value);

Parámetros de chamada:

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

removeHeader

Elimina todas as cabeceiras das mensaxes do valor da clave especificado

1
HttpMessage.removeHeader(String name);

Parámetros de chamada:

  • name: Cadea, especifica a clave a eliminar

read

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

1
Buffer HttpMessage.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 HttpMessage.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
HttpMessage.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 HttpMessage.json(Value data);

Parámetros de chamada:

  • data: Valor, dados os datos a escribir

Resultado de volta:

  • Value, Este método non devolverá datos

Analice os datos da mensaxe na codificación JSON

1
Value HttpMessage.json();

Resultado de volta:

  • Value, Devolve o resultado analizado

pack

Para msgpack Codificar para escribir os datos dados

1
Value HttpMessage.pack(Value data);

Parámetros de chamada:

  • data: Valor, dados os datos a escribir

Resultado de volta:

  • Value, Este método non devolverá datos

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

1
Value HttpMessage.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
HttpMessage.end();

isEnded

Consulta se rematou a mensaxe actual

1
Boolean HttpMessage.isEnded();

Resultado de volta:

  • Boolean, Volve verdadeiro ao final

clear

Limpa o contido da mensaxe

1
HttpMessage.clear();

sendTo

Envía unha mensaxe formatada ao obxecto de fluxo dado

1
HttpMessage.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
HttpMessage.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 HttpMessage.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 HttpMessage.toJSON(String key = "");

Parámetros de chamada:

  • key: Cadea, sen usar

Resultado de volta:

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