Objecte objecte incorporat

Objecte WebSocketMessage

objecte de missatge websocket

Mètode de creació:

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

Herència

#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 d'objectes de missatges de processament de paquets

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

Paràmetres de trucada:

  • type: Enter, tipus de missatge de websocket, el valor per defecte és websocket.BINARY
  • masked: Booleà, màscara de missatge de websocket, el valor per defecte és cert
  • compress: Booleà, marqueu si el missatge està comprimit, si el valor per defecte és fals
  • maxSize: Enter, la mida màxima del paquet, en MB, per defecte és 67108864 (64M)

constant

TEXT

Especifiqueu el tipus de missatge 1, que representa un tipus de text

1
const WebSocketMessage.TEXT = 1;

BINARY

Especifiqueu el tipus de missatge 2, que representa un tipus binari

1
const WebSocketMessage.BINARY = 2;

Atributs de membre

masked

Marca booleana, consulta i llegeix la màscara de socket web, el valor per defecte és cert

1
Boolean WebSocketMessage.masked;

compress

Booleà, consulta i llegeix l'estat de compressió de websocket, per defecte és fals

1
Boolean WebSocketMessage.compress;

maxSize

Enter, consulteu i configureu la mida màxima del paquet, en bytes; el valor per defecte és 67108864 (64M)

1
Integer WebSocketMessage.maxSize;

value

String, el contingut bàsic del missatge

1
String WebSocketMessage.value;

params

NArray, els paràmetres bàsics del missatge

1
readonly NArray WebSocketMessage.params;

type

Enter, tipus de missatge

1
Integer WebSocketMessage.type;

data

Valor, consulta les dades del missatge, aquest atribut retornarà dades diferents segons el tipus de contingut, quan sigui text, retorna el text, que és json En tornar json, Altres vegades tornen al binari

1
readonly Value WebSocketMessage.data;

body

SeekableStream, L'objecte de flux que conté la part de dades del missatge

1
SeekableStream WebSocketMessage.body;

length

Llarg, la longitud de la part de dades del missatge

1
readonly Long WebSocketMessage.length;

stream

Stream, Consulteu l'objecte de flux quan el missatge es llegeix des de

1
readonly Stream WebSocketMessage.stream;

lastError

Cadena, consulta i defineix l'últim error de processament de missatges

1
String WebSocketMessage.lastError;

Funció de membre

read

Llegiu les dades de la mida especificada del flux, aquest mètode és l'àlies del mètode de cos corresponent

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

Paràmetres de trucada:

  • bytes: Enter, especifiqueu la quantitat de dades que cal llegir, el valor per defecte és llegir un bloc de dades de mida aleatòria, la mida de les dades llegides depèn del dispositiu

Resultat de retorn:

  • Buffer, Torneu les dades llegides del flux, si no hi ha dades per llegir o si la connexió s'interromp, torneu a ser nul

readAll

Llegiu totes les dades restants del flux, aquest mètode és un àlies del mètode de cos corresponent

1
Buffer WebSocketMessage.readAll() async;

Resultat de retorn:

  • Buffer, Torneu les dades llegides del flux, si no hi ha dades per llegir o si la connexió s'interromp, torneu a ser nul

write

Escriviu les dades donades, aquest mètode és l'àlies del mètode de cos corresponent

1
WebSocketMessage.write(Buffer data) async;

Paràmetres de trucada:

  • data: Buffer, Tenint en compte les dades a escriure

json

Escriviu les dades donades a la codificació JSON

1
Value WebSocketMessage.json(Value data);

Paràmetres de trucada:

  • data: Valor, donades les dades que cal escriure

Resultat de retorn:

  • Value, Aquest mètode no retornarà dades

Analitzeu les dades del missatge a la codificació JSON

1
Value WebSocketMessage.json();

Resultat de retorn:

  • Value, Retorna el resultat analitzat

pack

per msgpack Codificar per escriure les dades donades

1
Value WebSocketMessage.pack(Value data);

Paràmetres de trucada:

  • data: Valor, donades les dades que cal escriure

Resultat de retorn:

  • Value, Aquest mètode no retornarà dades

per msgpack Codificació i anàlisi de les dades del missatge

1
Value WebSocketMessage.pack();

Resultat de retorn:

  • Value, Retorna el resultat analitzat

end

Definiu el final del processament actual del missatge,Chain El processador no continua les transaccions posteriors

1
WebSocketMessage.end();

isEnded

Consulteu si el missatge actual s'ha acabat

1
Boolean WebSocketMessage.isEnded();

Resultat de retorn:

  • Boolean, Torneu a cert al final

clear

Esborreu el contingut del missatge

1
WebSocketMessage.clear();

sendTo

Envieu un missatge formatat a l'objecte de flux donat

1
WebSocketMessage.sendTo(Stream stm) async;

Paràmetres de trucada:

  • stm: Stream, Especifiqueu l'objecte de flux per rebre missatges amb format

readFrom

Llegiu el missatge formatat de l'objecte de flux de memòria cau donat i analitzeu l'objecte d'emplenament

1
WebSocketMessage.readFrom(Stream stm) async;

Paràmetres de trucada:

  • stm: Stream, Especifiqueu l'objecte de flux per llegir els missatges formatats

toString

Retorna la representació de cadena de l'objecte, generalment retorna "[Objecte natiu]", l'objecte es pot tornar a implementar segons les seves pròpies característiques

1
String WebSocketMessage.toString();

Resultat de retorn:

  • String, Retorna la representació de cadena de l'objecte

toJSON

Retorna la representació en format JSON de l'objecte, generalment retorna una col·lecció d'atributs llegibles definits per l'objecte

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

Paràmetres de trucada:

  • key: Cadena, sense utilitzar

Resultat de retorn:

  • Value, Retorna un valor que conté JSON serialitzable