Objeto incorporado

ObjetoMensaje

Objeto de mensaje básico

Los objetos de mensaje son compatibles conmqCada módulo se puede utilizar para construir un sistema de procesamiento de mensajes personalizado. El método de creación es:

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

relación de herencia

%0 object object toString() toJSON() Message Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() object->Message HttpMessage HttpMessage Message->HttpMessage WebSocketMessage WebSocketMessage Message->WebSocketMessage HttpRequest HttpRequest HttpMessage->HttpRequest HttpResponse HttpResponse HttpMessage->HttpResponse

Constructor

Message

Constructor de objetos de mensaje

1
new Message();

constante

TEXT

Especifique el tipo de mensaje 1, que representa un tipo de texto.

1
const Message.TEXT = 1;

BINARY

Especifique el tipo de mensaje 2, que representa un tipo binario.

1
const Message.BINARY = 2;

propiedades de miembros

value

Cadena, el contenido básico del mensaje.

1
String Message.value;

params

NArray, los parámetros básicos del mensaje.

1
readonly NArray Message.params;

type

Entero, tipo de mensaje

1
Integer Message.type;

data

Valor, consulta los datos del mensaje. Este atributo devolverá diferentes datos según el tipo de contenido. Cuando sea texto, se devolverá el texto.jsonregresar cuandojson, de lo contrario devuelve binario

1
readonly Value Message.data;

body

SeekableStream, un objeto de flujo que contiene la parte de datos del mensaje

1
SeekableStream Message.body;

length

Long, la longitud de la parte de datos del mensaje.

1
readonly Long Message.length;

stream

Stream, el objeto de flujo al consultar el mensaje readFrom

1
readonly Stream Message.stream;

lastError

Cadena, consulta y establece el último error de procesamiento de mensajes

1
String Message.lastError;

función miembro

read

Lee datos de tamaño especificado de la secuencia. Este método es un alias del método correspondiente del cuerpo.

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

Parámetros de llamada:

  • bytes: Entero, especifica la cantidad de datos que se leerán. El valor predeterminado es leer bloques de datos de tamaño aleatorio. El tamaño de los datos leídos depende del dispositivo.

Resultados de devolución:

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

readAll

Lea todos los datos restantes de la secuencia. Este método es un alias del método correspondiente del cuerpo.

1
Buffer Message.readAll() async;

Resultados de devolución:

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

write

Escribe los datos dados. Este método es un alias del método correspondiente en el cuerpo.

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

Parámetros de llamada:

  • data: Valor, dados los datos a escribir

Resultados de devolución:

  • Value, este método no devuelve datos

Analizar los datos del mensaje como codificación JSON.

1
Value Message.json();

Resultados de devolución:

  • Value, devuelve el resultado analizado

pack

pormsgpackLa codificación escribe los datos dados.

1
Value Message.pack(Value data);

Parámetros de llamada:

  • data: Valor, dados los datos a escribir

Resultados de devolución:

  • Value, este método no devuelve datos

pormsgpackCodificar y analizar los datos del mensaje.

1
Value Message.pack();

Resultados de devolución:

  • Value, devuelve el resultado analizado

end

Establecer el final del procesamiento del mensaje actual,ChainEl procesador no continúa con transacciones posteriores.

1
Message.end();

isEnded

Consultar si el mensaje actual ha finalizado

1
Boolean Message.isEnded();

Resultados de devolución:

  • Boolean, devuelve verdadero cuando termina

clear

Borrar contenido del mensaje

1
Message.clear();

sendTo

Envía un mensaje formateado al objeto de flujo dado

1
Message.sendTo(Stream stm) async;

Parámetros de llamada:

  • stm:Stream, especifica el objeto de flujo que recibe el mensaje formateado

readFrom

Lee el mensaje formateado del objeto de flujo de caché dado y analiza el objeto poblado

1
Message.readFrom(Stream stm) async;

Parámetros de llamada:

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

toString

Devuelve la representación de cadena del objeto. Generalmente, se devuelve "[Objeto nativo]". El objeto se puede volver a implementar de acuerdo con sus propias características.

1
String Message.toString();

Resultados de devolución:

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

toJSON

Devuelve una representación en formato JSON del objeto, que generalmente devuelve una colección de propiedades legibles definidas por el objeto.

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

Parámetros de llamada:

  • key: Cadena, no utilizada

Resultados de devolución:

  • Value, devuelve un valor que contiene JSON serializable