Objekt eingebautes Objekt

Objekt WebSocketMessage

Websocket-Nachrichtenobjekt

Erstellungsmethode:

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

Nachlass

#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()

Konstrukteur

WebSocketMessage

Nachrichtenobjektkonstruktor für die Paketverarbeitung

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

Aufrufparameter:

  • type: Integer, Websocket-Nachrichtentyp, der Standardwert ist websocket.BINARY
  • masked: Boolean, Websocket-Nachrichtenmaske, Standard 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 Nachrichtentyp 2 an, der einen binären Typ darstellt

1
const WebSocketMessage.BINARY = 2;

Mitgliedsattribute

masked

Boolean, Websocket-Maskenmarkierung abfragen und lesen, der Standardwert ist true

1
Boolean WebSocketMessage.masked;

compress

Boolean, Websocket-Komprimierungsstatus abfragen und lesen, Standardwert ist false

1
Boolean WebSocketMessage.compress;

maxSize

Integer, Abfrage und Festlegen der maximalen Paketgröße in Byte, der Standardwert ist 67108864 (64M)

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, fragt die Daten der Nachricht ab, dieses Attribut gibt je nach Inhaltstyp unterschiedliche Daten zurück, wenn es sich um Text handelt, gibt es den Text zurück, der ist json Bei der Rückkehr json, Andere Zeiten kehren zu binär zurück

1
readonly Value WebSocketMessage.data;

body

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

1
SeekableStream WebSocketMessage.body;

length

Long, die Länge des Datenteils der Nachricht

1
readonly Long WebSocketMessage.length;

stream

Stream, Fragt das Stream-Objekt ab, wenn die Nachricht readFrom

1
readonly Stream WebSocketMessage.stream;

lastError

String, Abfrage und Einstellung des letzten Fehlers der Nachrichtenverarbeitung

1
String WebSocketMessage.lastError;

Mitgliederfunktion

read

Liest die Daten der angegebenen Größe aus dem Stream, diese Methode ist der Alias ​​der entsprechenden Methode von body

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

Aufrufparameter:

  • bytes: Integer, geben Sie die zu lesende Datenmenge an, standardmäßig wird ein Datenblock zufälliger Größe gelesen, die Größe der gelesenen Daten hängt vom Gerät ab

Ergebnis zurückgeben:

  • Buffer, Die aus dem Stream gelesenen Daten zurückgeben, wenn keine Daten zum Lesen vorhanden sind oder die Verbindung unterbrochen ist, dann null zurückgeben

readAll

Lies alle verbleibenden Daten aus dem Stream, diese Methode ist ein Alias ​​der entsprechenden Methode von body

1
Buffer WebSocketMessage.readAll() async;

Ergebnis zurückgeben:

  • Buffer, Die aus dem Stream gelesenen Daten zurückgeben, wenn keine Daten zum Lesen vorhanden sind oder die Verbindung unterbrochen ist, dann null zurückgeben

write

Schreiben Sie die angegebenen Daten, diese Methode ist der Alias ​​der entsprechenden Methode von body

1
WebSocketMessage.write(Buffer data) async;

Aufrufparameter:

  • data: Buffer, Angesichts der zu schreibenden Daten

json

Schreiben Sie die angegebenen Daten in JSON-Codierung

1
Value WebSocketMessage.json(Value data);

Aufrufparameter:

  • data: Wert, gegeben die 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, Das geparste Ergebnis zurückgeben

pack

von msgpack Codieren, um die angegebenen Daten zu schreiben

1
Value WebSocketMessage.pack(Value data);

Aufrufparameter:

  • data: Wert, gegeben die zu schreibenden Daten

Ergebnis zurückgeben:

  • Value, Diese Methode gibt keine Daten zurück

von msgpack Codieren und Parsen der Daten in der Nachricht

1
Value WebSocketMessage.pack();

Ergebnis zurückgeben:

  • Value, Das geparste Ergebnis zurückgeben

end

Setzen Sie das Ende der aktuellen Nachrichtenverarbeitung,Chain Der Prozessor setzt nachfolgende Transaktionen nicht fort

1
WebSocketMessage.end();

isEnded

Abfrage, ob die aktuelle Nachricht zu Ende ist

1
Boolean WebSocketMessage.isEnded();

Ergebnis zurückgeben:

  • Boolean, Gib am Ende true zurück

clear

Inhalt der Nachricht löschen

1
WebSocketMessage.clear();

sendTo

Senden Sie eine formatierte Nachricht an das angegebene Stream-Objekt

1
WebSocketMessage.sendTo(Stream stm) async;

Aufrufparameter:

  • stm: Stream, Geben Sie das Stream-Objekt an, um formatierte Nachrichten zu empfangen

readFrom

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

1
WebSocketMessage.readFrom(Stream stm) async;

Aufrufparameter:

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

toString

Gibt die String-Darstellung des Objekts zurück, gibt im Allgemeinen "[Native Object]" zurück, das Objekt kann entsprechend seiner eigenen Eigenschaften neu 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, gibt im Allgemeinen eine Sammlung von lesbaren Attributen zurück, die durch das Objekt definiert sind

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

Aufrufparameter:

  • key: String, unbenutzt

Ergebnis zurückgeben:

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