Objeto objeto integrado

Objeto WebSocketMessage

objeto de mensaje websocket

Método de creación:

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 : Integer, tipo de mensaje websocket, el valor predeterminado es websocket.BINARY
  • masked : booleano, máscara de mensaje websocket, el valor predeterminado es verdadero
  • compress : booleano, marque 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, que representa un tipo de texto

1
const WebSocketMessage.TEXT = 1;

BINARY

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

1
const WebSocketMessage.BINARY = 2;

Atributos de miembros

masked

Marca de máscara booleana, consulta y lectura de websocket, el valor predeterminado es verdadero

1
Boolean WebSocketMessage.masked;

compress

Booleano, consulta y lee el estado de compresión de 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

String, 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 los datos del mensaje

1
readonly Value WebSocketMessage.data;

body

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

1
SeekableStream WebSocketMessage.body;

length

Long, la longitud de la parte de datos del mensaje

1
readonly Long WebSocketMessage.length;

stream

Stream , el objeto de flujo al consultar el mensaje readFrom

1
readonly Stream WebSocketMessage.stream;

lastError

Cadena, consulta y configuración del último error de procesamiento de mensajes

1
String WebSocketMessage.lastError;

Función miembro

read

Leer datos del tamaño especificado de la secuencia, este método es un alias del método correspondiente de cuerpo

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

Parámetros de llamada:

  • bytes : entero, especifique 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

Devolver resultado:

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

readAll

Leer todos los datos restantes de la secuencia, este método es un alias del método correspondiente de body

1
Buffer WebSocketMessage.readAll() async;

Devolver resultado:

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

write

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

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

Devolver resultado:

  • Value , este método no devolverá datos

Analizar los datos del mensaje en codificación JSON

1
Value WebSocketMessage.json();

Devolver resultado:

  • Value , devuelve el resultado analizado

end

Configure el procesamiento de mensajes actual para que finalice, y el procesador de Chain no continuará las transacciones posteriores

1
WebSocketMessage.end();

isEnded

Consultar si el mensaje actual ha terminado

1
Boolean WebSocketMessage.isEnded();

Devolver resultado:

  • Boolean , devuelve verdadero al final

clear

Borrar el contenido del mensaje

1
WebSocketMessage.clear();

sendTo

Envía un mensaje formateado al objeto de transmisión dado

1
WebSocketMessage.sendTo(Stream stm) async;

Parámetros de llamada:

  • stm : Stream , especifica el objeto de flujo que recibe mensajes formateados

readFrom

Leer el mensaje formateado del objeto de flujo de caché dado y analizar el objeto de relleno

1
WebSocketMessage.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 devuelve "[Objeto nativo]", el objeto se puede volver a implementar de acuerdo con sus propias características

1
String WebSocketMessage.toString();

Devolver resultado:

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

toJSON

Devuelve la representación en formato JSON del objeto, generalmente devuelve una colección de atributos legibles definidos por el objeto

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

Parámetros de llamada:

  • key : String, sin usar

Devolver resultado:

  • Value , devuelve un valor que contiene JSON serializable