Objekt eingebautes Objekt

Objekt WebSocketMessage

Websocket-Nachrichtenobjekt

Erstellungsmethode:

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

Vererbung

Konstruktor

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, Standard ist websocket.BINARY
  • masked : Boolesche 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 (64 MB).

Konstante

TEXT

Geben Sie den Nachrichtentyp 1 für einen Texttyp an

1
const WebSocketMessage.TEXT = 1;

BINARY

Geben Sie den Nachrichtentyp 2 für einen Binärtyp an

1
const WebSocketMessage.BINARY = 2;

Mitgliedsattribute

masked

Standardmäßig ist Boolean, Abfragen und Lesen von Websocket-Masken-Tags

1
Boolean WebSocketMessage.masked;

compress

Boolescher Status für die Komprimierung von Websockets, Abfrage und Lesen, Standard ist false

1
Boolean WebSocketMessage.compress;

maxSize

Ganzzahl, Abfrage und Festlegen der maximalen Paketgröße in Byte.

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, Nachrichtendaten abfragen

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 in der Nachrichtenverarbeitung

1
String WebSocketMessage.lastError;

Mitgliedsfunktion

read

Liest Daten der angegebenen Größe aus dem Stream. Diese Methode ist ein Alias ​​für die entsprechende Body-Methode.

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

Parameter aufrufen:

  • bytes : Integer, gibt 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.

Gibt das Ergebnis zurück:

  • Buffer , geben Sie die aus dem Stream gelesenen Daten zurück oder null, wenn keine zu lesenden Daten vorhanden sind oder die Verbindung unterbrochen ist

readAll

Lesen Sie alle verbleibenden Daten aus dem Stream. Diese Methode ist ein Alias ​​für die entsprechende Body-Methode.

1
Buffer WebSocketMessage.readAll() async;

Gibt das Ergebnis zurück:

  • Buffer , geben Sie die aus dem Stream gelesenen Daten zurück oder null, wenn keine zu lesenden Daten vorhanden sind oder die Verbindung unterbrochen ist

write

Schreiben Sie die angegebenen Daten, diese Methode ist ein Alias ​​für die entsprechende 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

Gibt das Ergebnis zurück:

  • Value , diese Methode gibt keine Daten zurück

Analysieren Sie Daten in Nachrichten als JSON

1
Value WebSocketMessage.json();

Gibt das Ergebnis zurück:

  • Value , gibt das analysierte Ergebnis zurück

end

Wenn Sie das Ende der aktuellen Nachrichtenverarbeitung festlegen, setzt der Chain die nachfolgenden Transaktionen nicht fort

1
WebSocketMessage.end();

isEnded

Fragen Sie ab, ob die aktuelle Nachricht endet

1
Boolean WebSocketMessage.isEnded();

Gibt das Ergebnis zurück:

  • Boolean , gibt am Ende true zurück

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 , der das Stream-Objekt angibt, das formatierte Nachrichten empfangen soll

readFrom

Liest formatierte Nachrichten aus dem angegebenen Cache-Stream-Objekt und analysiert das gefüllte Objekt

1
WebSocketMessage.readFrom(Stream stm) async;

Parameter aufrufen:

  • stm : Stream , der ein Stream-Objekt zum Lesen formatierter Nachrichten angibt

toString

Gibt eine Zeichenfolgendarstellung des Objekts zurück, normalerweise "[Native Object]". Objekte können gemäß ihren eigenen Merkmalen neu implementiert werden

1
String WebSocketMessage.toString();

Gibt das Ergebnis zurück:

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

toJSON

Gibt eine JSON-Darstellung des Objekts zurück, die normalerweise eine Sammlung lesbarer Eigenschaften zurückgibt, die vom Objekt definiert wurden

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

Parameter aufrufen:

  • key : String, unbenutzt

Gibt das Ergebnis zurück:

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