Obxecto WebSocketMessage
obxecto de mensaxe web
Método de creación:
1
2
3var ws = require("ws");
var msg = new ws.Message();
Herdanza
Construtor
WebSocketMessage
Constructor de obxectos de mensaxes de procesamento de paquetes
1
2
3
4new WebSocketMessage(Integer type = ws.BINARY,
Boolean masked = true,
Boolean compress = false,
Integer maxSize = 67108864);
Parámetros de chamada:
- type: Entero, tipo de mensaxe de websocket, o predeterminado é websocket.BINARY
- masked: Booleano, máscara de mensaxes de portada web, o predeterminado é verdadeiro
- compress: Booleano, marque se a mensaxe está comprimida, o predeterminado é falso
- maxSize: Enteiro, o tamaño máximo do paquete, en MB, o predeterminado é 67108864 (64M)
constante
TEXT
Especifique o tipo de mensaxe 1, que representa un tipo de texto
1const WebSocketMessage.TEXT = 1;
BINARY
Especifique o tipo de mensaxe 2, que representa un tipo binario
1const WebSocketMessage.BINARY = 2;
Atributos dos membros
masked
Marca booleana, consulta e le a máscara de socket web, o predeterminado é verdadeiro
1Boolean WebSocketMessage.masked;
compress
Booleano, consulta e le o estado de compresión de portátiles, o predeterminado é falso
1Boolean WebSocketMessage.compress;
maxSize
Entero, consulta e define o tamaño máximo do paquete, en bytes, o predeterminado é 67108864 (64M)
1Integer WebSocketMessage.maxSize;
value
Cadea, o contido básico da mensaxe
1String WebSocketMessage.value;
params
NArray, os parámetros básicos da mensaxe
1readonly NArray WebSocketMessage.params;
type
Entero, tipo de mensaxe
1Integer WebSocketMessage.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
1readonly Value WebSocketMessage.data;
body
SeekableStream, O obxecto de fluxo que contén a parte de datos da mensaxe
1SeekableStream WebSocketMessage.body;
length
Longo, a lonxitude da parte de datos da mensaxe
1readonly Long WebSocketMessage.length;
stream
Stream, Consulte o obxecto de transmisión cando a mensaxe lea De
1readonly Stream WebSocketMessage.stream;
lastError
Cadea, consulta e configura o último erro do procesamento de mensaxes
1String WebSocketMessage.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
1Buffer WebSocketMessage.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
1Buffer WebSocketMessage.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
1WebSocketMessage.write(Buffer data) async;
Parámetros de chamada:
- data: Buffer, Dados os datos a escribir
json
Escribe os datos dados na codificación JSON
1Value WebSocketMessage.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
1Value WebSocketMessage.json();
Resultado de volta:
- Value, Devolve o resultado analizado
pack
por msgpack Codificar para escribir os datos dados
1Value WebSocketMessage.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
1Value WebSocketMessage.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
1WebSocketMessage.end();
isEnded
Consulta se rematou a mensaxe actual
1Boolean WebSocketMessage.isEnded();
Resultado de volta:
- Boolean, Volve verdadeiro ao final
clear
Limpa o contido da mensaxe
1WebSocketMessage.clear();
sendTo
Envía unha mensaxe formatada ao obxecto de fluxo dado
1WebSocketMessage.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
1WebSocketMessage.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
1String WebSocketMessage.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
1Value WebSocketMessage.toJSON(String key = "");
Parámetros de chamada:
- key: Cadea, sen usar
Resultado de volta:
- Value, Devolve un valor que contén JSON serializable