Objeto objeto incorporado

Objeto WebSocketMessage

objeto de mensaje websocket

Crear método:

1 2 3
var ws = require("ws"); var msg = new ws.Message();

Herencia

Constructor

WebSocketMessage

Constructor de objetos de mensaje de procesamiento de paquetes

1 2 3 4
new WebSocketMessage(Integer type = ws.BINARY, Boolean masked = true, Boolean compress = false, Integer maxSize = 67108864);

Parámetros de llamada:

  • type : entero, tipo de mensaje websocket, el valor predeterminado es websocket.BINARY
  • masked : booleano, máscara de mensaje websocket, el valor predeterminado es verdadero
  • compress : booleano, marca si el mensaje está comprimido, el valor predeterminado es falso
  • maxSize : Entero, el tamaño máximo de paquete en MB, el valor predeterminado es 67108864 (64M)

Constante

TEXT

Especifique el tipo de mensaje 1 para un tipo de texto

1
const WebSocketMessage.TEXT = 1;

BINARY

Especifique el tipo de mensaje 2 para un tipo binario

1
const WebSocketMessage.BINARY = 2;

Atributos de miembro

masked

Booleano, consulta y lee etiquetas de máscara websocket, el valor predeterminado es verdadero

1
Boolean WebSocketMessage.masked;

compress

Booleano, consulta y lee el estado de compresión del websocket, el valor predeterminado es falso

1
Boolean WebSocketMessage.compress;

maxSize

Entero, consulta y establece el tamaño máximo de paquete, en bytes, el valor predeterminado es 67108864 (64M)

1
Integer WebSocketMessage.maxSize;

value

Cadena, el contenido básico del mensaje.

1
String WebSocketMessage.value;

params

NArray, los parámetros básicos del mensaje

1
readonly NArray WebSocketMessage.params;

type

Entero, tipo de mensaje

1
Integer WebSocketMessage.type;

data

Valor, consulta de datos del mensaje

1
readonly Value WebSocketMessage.data;

body

SeekableStream , un objeto SeekableStream que contiene la porción de datos del mensaje

1
SeekableStream WebSocketMessage.body;

length

Largo, la longitud de la parte de datos del mensaje

1
readonly Long WebSocketMessage.length;

stream

Stream , el objeto stream al consultar el mensaje readFrom

1
readonly Stream WebSocketMessage.stream;

lastError

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

1
String WebSocketMessage.lastError;

Función miembro

read

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

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

Parámetros de llamada:

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

Devuelve el resultado:

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

readAll

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

1
Buffer WebSocketMessage.readAll() async;

Devuelve el resultado:

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

write

Escriba los datos dados, este método es un alias para el método correspondiente del cuerpo

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

Parámetros de llamada:

  • data : Valor, dados los datos a escribir

Devuelve el resultado:

  • Value , este método no devuelve datos

Analizar datos en mensajes como JSON

1
Value WebSocketMessage.json();

Devuelve el resultado:

  • Value , devuelve el resultado analizado

end

Establezca el final del procesamiento del mensaje actual, el procesador de la Chain no continuará las transacciones posteriores

1
WebSocketMessage.end();

isEnded

Consulta si finaliza el mensaje actual

1
Boolean WebSocketMessage.isEnded();

Devuelve el resultado:

  • Boolean , devuelve verdadero al final

clear

Borrar el contenido del mensaje

1
WebSocketMessage.clear();

sendTo

Enviar un mensaje formateado al objeto de flujo dado

1
WebSocketMessage.sendTo(Stream stm) async;

Parámetros de llamada:

  • stm : Stream , especificando el objeto de stream para recibir mensajes formateados

readFrom

Lee mensajes formateados del objeto de flujo de caché dado y analiza el objeto lleno

1
WebSocketMessage.readFrom(Stream stm) async;

Parámetros de llamada:

  • stm : Stream , especificando un objeto de flujo para leer mensajes formateados

toString

Devuelve una representación de cadena del objeto, generalmente "[Objeto nativo]". Los objetos se pueden volver a implementar de acuerdo con sus propias características

1
String WebSocketMessage.toString();

Devuelve el resultado:

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

toJSON

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

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

Parámetros de llamada:

  • key : cadena, sin usar

Devuelve el resultado:

  • Value , devuelve un valor que contiene un JSON serializable