Objekt eingebautes Objekt

Objekt WebSocketMessage

Websocket-Nachrichtenobjekt

Erstellungsmethode:

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

Erbe

Konstrukteur

WebSocketMessage

Konstruktor für Paketverarbeitungsnachrichtenobjekte

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

Parameter aufrufen:

  • type : Ganzzahl, Websocket-Nachrichtentyp, der Standardwert ist websocket.BINARY
  • masked : Boolesche Websocket-Nachrichtenmaske, der Standardwert ist true
  • compress : Boolean, markieren Sie, ob die Nachricht komprimiert ist, der Standardwert ist false
  • maxSize : Integer, die maximale Paketgröße, in MB, der Standardwert ist 67108864 (64M)

Konstante

TEXT

Geben Sie den Nachrichtentyp 1 an, der einen Texttyp darstellt

1
const WebSocketMessage.TEXT = 1;

BINARY

Geben Sie den Nachrichtentyp 2 an, der einen Binärtyp darstellt

1
const WebSocketMessage.BINARY = 2;

Mitgliedsattribute

masked

Boolesche, abgefragte und gelesene Websocket-Maskenmarke, Standard ist true

1
Boolean WebSocketMessage.masked;

compress

Boolescher, Socket- und Read-Websocket-Komprimierungsstatus, Standard ist false

1
Boolean WebSocketMessage.compress;

maxSize

Ganzzahl, Abfrage und Festlegen der maximalen Paketgröße in Byte. Der Standardwert ist 67108864 (64 MB).

1
Integer WebSocketMessage.maxSize;

value

String, der grundlegende Inhalt der Nachricht

1
String WebSocketMessage.value;

params

NArray, die grundlegenden Parameter der Nachricht

1
readonly NArray WebSocketMessage.params;

type

Ganzzahl, Nachrichtentyp

1
Integer WebSocketMessage.type;

data

Wert, fragen Sie die Daten der Nachricht ab

1
readonly Value WebSocketMessage.data;

body

SeekableStream , ein Stream-Objekt, das den Datenteil der Nachricht enthält

1
SeekableStream WebSocketMessage.body;

length

Long, die Länge des Nachrichtendatenteils

1
readonly Long WebSocketMessage.length;

stream

Stream , das Stream-Objekt beim Abfragen der Nachricht readFrom

1
readonly Stream WebSocketMessage.stream;

lastError

Zeichenfolge, Abfrage und Festlegen des letzten Fehlers bei der Nachrichtenverarbeitung

1
String WebSocketMessage.lastError;

Mitgliedsfunktion

read

Lesen Sie Daten der angegebenen Größe aus dem Stream. Diese Methode ist ein Alias ​​der entsprechenden Body-Methode

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

Parameter aufrufen:

  • bytes : Ganzzahl, geben Sie die zu lesende Datenmenge an. Standardmäßig werden Datenblöcke mit zufälliger Größe gelesen. Die Größe der gelesenen Daten hängt vom Gerät ab

Ergebnis zurückgeben:

  • Buffer gibt die aus dem Stream gelesenen Daten zurück. Wenn keine zu lesenden Daten vorhanden sind oder die Verbindung unterbrochen ist, wird null zurückgegeben

readAll

Lesen Sie alle verbleibenden Daten aus dem Stream. Diese Methode ist ein Alias ​​der entsprechenden Body-Methode

1
Buffer WebSocketMessage.readAll() async;

Ergebnis zurückgeben:

  • Buffer gibt die aus dem Stream gelesenen Daten zurück. Wenn keine zu lesenden Daten vorhanden sind oder die Verbindung unterbrochen ist, wird null zurückgegeben

write

Schreiben Sie die angegebenen Daten, diese Methode ist der Alias ​​der entsprechenden Methode des Körpers

1
WebSocketMessage.write(Buffer data) async;

Parameter aufrufen:

  • data : Buffer , gegeben die zu schreibenden Daten

json

Schreiben Sie die angegebenen Daten in JSON-Codierung

1
Value WebSocketMessage.json(Value data);

Parameter aufrufen:

  • data : Wert unter Angabe der zu schreibenden Daten

Ergebnis zurückgeben:

  • Value , diese Methode gibt keine Daten zurück

Analysieren Sie die Daten in der Nachricht in JSON-Codierung

1
Value WebSocketMessage.json();

Ergebnis zurückgeben:

  • Value , gibt das analysierte Ergebnis zurück

end

Setzen Sie die aktuelle Nachrichtenverarbeitung auf Ende, und der Chain setzt nachfolgende Transaktionen nicht fort

1
WebSocketMessage.end();

isEnded

Fragen Sie ab, ob die aktuelle Nachricht beendet ist

1
Boolean WebSocketMessage.isEnded();

Ergebnis zurückgeben:

  • Boolean , am Ende true zurückgeben

clear

Löschen Sie den Inhalt der Nachricht

1
WebSocketMessage.clear();

sendTo

Senden Sie eine formatierte Nachricht an das angegebene Stream-Objekt

1
WebSocketMessage.sendTo(Stream stm) async;

Parameter aufrufen:

  • stm : Stream , gibt das Stream-Objekt an, das formatierte Nachrichten empfängt

readFrom

Lesen Sie die formatierte Nachricht aus dem angegebenen Cache-Stream-Objekt und analysieren Sie das Füllobjekt

1
WebSocketMessage.readFrom(Stream stm) async;

Parameter aufrufen:

  • stm : Stream , gibt das Stream-Objekt zum Lesen formatierter Nachrichten an

toString

Gibt die Zeichenfolgendarstellung des Objekts zurück, gibt im Allgemeinen "[Native Object]" zurück. Das Objekt kann gemäß seinen eigenen Merkmalen erneut implementiert werden

1
String WebSocketMessage.toString();

Ergebnis zurückgeben:

  • String , gibt die String-Darstellung des Objekts zurück

toJSON

Gibt die Darstellung des Objekts im JSON-Format zurück und gibt im Allgemeinen eine Sammlung lesbarer Attribute zurück, die vom Objekt definiert wurden

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

Parameter aufrufen:

  • key : String, unbenutzt

Ergebnis zurückgeben:

  • Value , gibt einen Wert zurück, der JSON serialisierbar enthält