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

#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>WebSocketMessage|new WebSocketMessage()|masked;compress;maxSize] [object] <:- [Message] [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() WebSocketMessage new WebSocketMessage() masked compress maxSize object toString() toJSON()

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 de 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 del 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, este atributo devolverá datos diferentes según el tipo de contenido, cuando es texto, devuelve el texto, que es json Al regresar json, Otras veces vuelven a binario

1
readonly Value WebSocketMessage.data;

body

SeekableStream, El 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, Consultar el objeto de flujo cuando 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

Lea los datos del tamaño especificado de la secuencia, este método es el alias del método de cuerpo correspondiente

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 un bloque 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 secuencia, 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 secuencia, si no hay datos para leer o la conexión se interrumpe, devuelve nulo

write

Escribe 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

pack

por msgpack Codificar para escribir los datos dados

1
Value WebSocketMessage.pack(Value data);

Parámetros de llamada:

  • data: Valor, dados los datos a escribir

Devolver resultado:

  • Value, Este método no devolverá datos

por msgpack Codificar y analizar los datos del mensaje

1
Value WebSocketMessage.pack();

Devolver resultado:

  • Value, Devuelve el resultado analizado

end

Establecer el final del procesamiento del mensaje actual,Chain El procesador no continúa 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, Especifique el objeto de flujo para recibir 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, Especifique el objeto de flujo para leer mensajes formateados

toString

Devuelve la representación en cadena del objeto, generalmente devuelve "[Native Object]", 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: Cadena, sin usar

Devolver resultado:

  • Value, Devuelve un valor que contiene JSON serializable