Obxecto incorporado

Mensaxe de obxecto

Obxecto de mensaxe básico

O obxecto Message é compatible con mq Cada módulo pode usarse para construír un sistema de procesamento de mensaxes personalizado, creando métodos:

1 2
var mq = require("mq"); var m = new mq.Message();

Herdanza

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<this>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] [<class>HttpRequest] [<class>HttpResponse] [<class>WebSocketMessage] [object] <:- [Message] [Message] <:- [HttpMessage] [HttpMessage] <:- [HttpRequest] [HttpMessage] <:- [HttpResponse] [Message] <:- [WebSocketMessage] Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() object toString() toJSON() HttpMessage HttpRequest HttpResponse WebSocketMessage

Construtor

Message

Construtor de obxectos de mensaxe

1
new Message();

constante

TEXT

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

1
const Message.TEXT = 1;

BINARY

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

1
const Message.BINARY = 2;

Atributos dos membros

value

Cadea, o contido básico da mensaxe

1
String Message.value;

params

NArray, os parámetros básicos da mensaxe

1
readonly NArray Message.params;

type

Entero, tipo de mensaxe

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

body

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

1
SeekableStream Message.body;

length

Longo, a lonxitude da parte de datos da mensaxe

1
readonly Long Message.length;

stream

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

1
readonly Stream Message.stream;

lastError

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

1
String Message.lastError;

Función de membro

read

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

1
Buffer Message.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 Message.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
Message.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 Message.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 Message.json();

Resultado de volta:

  • Value, Devolve o resultado analizado

pack

por msgpack Codificar para escribir os datos dados

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

isEnded

Consulta se rematou a mensaxe actual

1
Boolean Message.isEnded();

Resultado de volta:

  • Boolean, Volve verdadeiro ao final

clear

Limpa o contido da mensaxe

1
Message.clear();

sendTo

Envía unha mensaxe formatada ao obxecto de fluxo dado

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

Parámetros de chamada:

  • key: Cadea, sen usar

Resultado de volta:

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