Objekt WebSocket

WebSocket Paketprotokoll-Konvertierungsprozessor

Es wird verwendet, um das HTTP-Protokoll in eine WebSocket-Paketprotokollnachricht zu konvertieren. Erstellungsmethode:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
var ws = require('ws');
var http = require('http');

var serv = new http.Server(8811, ws.upgrade((conn) => {
    conn.onmessage = msg => {
        conn.send(new Date());
    };
}));

serv.run(r => 0);

var sock = new ws.Socket('ws://127.0.0.1:8811');
sock.on('open', () => {
    setInterval(() => {
        sock.send('get date');
    }, 1000);
});

sock.onmessage = evt => {
    console.log(evt.data);
}

Erbe

Konstrukteur

WebSocket

WebSocket-Konstruktor

1
2
3
new WebSocket(String url,
    String protocol = "",
    String origin = "");

Aufrufparameter:

url: String, geben Sie den verbundenen Server an
protocol: String, geben Sie das Handshake-Protokoll an, der Standardwert ist ""
origin: String, geben Sie die Quelle an, die beim Handshake simuliert werden soll, der Standardwert ist ""

WebSocket-Konstruktor

1
2
new WebSocket(String url,
    Object opts);

Aufrufparameter:

url: String, geben Sie den verbundenen Server an
opts: Objekt, Verbindungsoption, Standard ist {}

opts enthält zusätzliche angeforderte Optionen und der unterstützte Inhalt ist wie folgt:

1
2
3
4
5
6
7
8{
    "protocol": "", // 指定握手协议，缺省为空
    "origin": "", // 指定握手时模拟的源，缺省为空
    "perMessageDeflate": true, // 指定是否支持压缩，缺省支持
    "maxPayload": 67108864, // 指定最大数据包尺寸，缺省为 67108864
    "httpClient": hc, // 自定义 httpClient 对象，缺省使用全局 httpClient
    "headers": // 指定 http(s) 连接时携带的 header，缺省为 {}，
}

Statische Eigenschaften

defaultMaxListeners

Integer, die standardmäßige globale maximale Anzahl von Listenern

1
static Integer WebSocket.defaultMaxListeners;

Mitgliedsattribute

url

String, fragt den Server ab, der mit dem aktuellen Objekt verbunden ist

1
readonly String WebSocket.url;

protocol

String, Abfrage des Protokolls, wenn das aktuelle Objekt verbunden ist

1
readonly String WebSocket.protocol;

origin

String, Abfrage der Quelle der aktuellen Objektverbindung

1
readonly String WebSocket.origin;

readyState

Integer, Verbindungsstatus des aktuellen Objekts abfragen, siehe ws

1readonly Integer WebSocket.readyState;

onopen

Funktions-, Abfrage- und Bindungserfolgsereignis, äquivalent zu on("open", func);

1
Function WebSocket.onopen;

onmessage

Funktion, Abfrage und Bindung des Ereignisses des Empfangens einer Nachricht von der anderen Partei, äquivalent zu on("message", func);

1
Function WebSocket.onmessage;

onclose

Funktion, Abfrage und Bindung des Ereignisses der Verbindungsschließung, äquivalent zu on("close", func);

1
Function WebSocket.onclose;

onerror

Funktions-, Abfrage- und Bindungsfehlerereignisse, äquivalent zu on("error", func);

1
Function WebSocket.onerror;

Mitgliederfunktion

close

Schließen Sie die aktuelle Verbindung, dieser Vorgang sendet ein CLOSE-Paket an den anderen Teilnehmer und wartet auf die Antwort des anderen Teilnehmers

1
2
WebSocket.close(Integer code = 1000,
    String reason = "");

Aufrufparameter:

code: Ganzzahl, geben Sie den zu schließenden Code an, der zulässige Wert ist 3000-4999 oder 1000, der Standardwert ist 1000
reason: String, geben Sie den Grund für das Schließen an, der Standardwert ist ""

send

Senden Sie eine SMS an die andere Partei

1
WebSocket.send(String data);

Aufrufparameter:

data: String, spezifizieren Sie den gesendeten Text

Senden Sie ein Stück Binärdaten an die andere Partei

1WebSocket.send(Buffer data);

Aufrufparameter:

data: Buffer, Geben Sie die zu sendenden Binärdaten an

ref

Verhindern Sie, dass der fibjs-Prozess beendet wird, und verhindern Sie, dass der fibjs-Prozess während der Objektbindung beendet wird

1WebSocket WebSocket.ref();

Ergebnis zurückgeben:

WebSocket, Gibt das aktuelle Objekt zurück

unref

Erlauben Sie dem fibjs-Prozess das Beenden und dem Fibjs-Prozess das Beenden während der Objektbindung

1WebSocket WebSocket.unref();

Ergebnis zurückgeben:

WebSocket, Gibt das aktuelle Objekt zurück

on

Binden Sie einen Ereignishandler an das Objekt the

1
2
Object WebSocket.on(String ev,
    Function func);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an
func: Funktion, Ereignisverarbeitungsfunktion angeben

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Binden Sie einen Ereignishandler an das Objekt the

1
Object WebSocket.on(Object map);

Aufrufparameter:

map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Name der Objekteigenschaft wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

addListener

Binden Sie einen Ereignishandler an das Objekt the

1
2
Object WebSocket.addListener(String ev,
    Function func);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an
func: Funktion, Ereignisverarbeitungsfunktion angeben

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Binden Sie einen Ereignishandler an das Objekt the

1
Object WebSocket.addListener(Object map);

Aufrufparameter:

map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Name der Objekteigenschaft wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

prependListener

Binden Sie einen Ereignishandler an den Anfang des Objekts

1
2
Object WebSocket.prependListener(String ev,
    Function func);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an
func: Funktion, Ereignisverarbeitungsfunktion angeben

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Binden Sie einen Ereignishandler an den Anfang des Objekts

1
Object WebSocket.prependListener(Object map);

Aufrufparameter:

map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Name der Objekteigenschaft wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

once

Binden Sie eine einmalige Ereignisverarbeitungsfunktion an das Objekt, die einmalige Verarbeitungsfunktion wird nur einmal ausgelöst

1
2
Object WebSocket.once(String ev,
    Function func);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an
func: Funktion, Ereignisverarbeitungsfunktion angeben

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Binden Sie eine einmalige Ereignisverarbeitungsfunktion an das Objekt, die einmalige Verarbeitungsfunktion wird nur einmal ausgelöst

1
Object WebSocket.once(Object map);

Aufrufparameter:

map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Name der Objekteigenschaft wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

prependOnceListener

Binden Sie einen Ereignishandler an den Anfang des Objekts

1
2
Object WebSocket.prependOnceListener(String ev,
    Function func);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an
func: Funktion, Ereignisverarbeitungsfunktion angeben

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Binden Sie einen Ereignishandler an den Anfang des Objekts

1
Object WebSocket.prependOnceListener(Object map);

Aufrufparameter:

map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Name der Objekteigenschaft wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

off

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

1
2
Object WebSocket.off(String ev,
    Function func);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an
func: Funktion, Ereignisverarbeitungsfunktion angeben

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Alle Funktionen in der Objektverarbeitungswarteschlange abbrechen

1
Object WebSocket.off(String ev);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

1
Object WebSocket.off(Object map);

Aufrufparameter:

map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

removeListener

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

1
2
Object WebSocket.removeListener(String ev,
    Function func);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an
func: Funktion, Ereignisverarbeitungsfunktion angeben

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Alle Funktionen in der Objektverarbeitungswarteschlange abbrechen

1
Object WebSocket.removeListener(String ev);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

1
Object WebSocket.removeListener(Object map);

Aufrufparameter:

map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

removeAllListeners

Abbrechen aller Listener aller Ereignisse aus der Objektverarbeitungswarteschlange Wenn ein Ereignis angegeben ist, entfernen Sie alle Listener des angegebenen Ereignisses.

1
Object WebSocket.removeAllListeners(String ev);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Abbrechen aller Listener aller Ereignisse aus der Objektverarbeitungswarteschlange Wenn ein Ereignis angegeben ist, entfernen Sie alle Listener des angegebenen Ereignisses.

1
Object WebSocket.removeAllListeners(Array evs = []);

Aufrufparameter:

evs: Array, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

setMaxListeners

Die Standardbegrenzung der Anzahl der Listener, nur aus Kompatibilitätsgründen

1WebSocket.setMaxListeners(Integer n);

Aufrufparameter:

n: Integer, geben Sie die Anzahl der Ereignisse an

getMaxListeners

Holen Sie sich das Standardlimit für die Anzahl der Listener, nur aus Kompatibilitätsgründen

1Integer WebSocket.getMaxListeners();

Ergebnis zurückgeben:

Integer, Zurück zur Standardgrenzzahl

listeners

Array von Listenern für das angegebene Ereignis des Abfrageobjekts

1
Array WebSocket.listeners(String ev);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

Array, Gibt ein Array von Listenern für das angegebene Ereignis zurück

listenerCount

Die Anzahl der Listener für das angegebene Ereignis des Abfrageobjekts

1
Integer WebSocket.listenerCount(String ev);

Aufrufparameter:

ev: String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

Integer, Gibt die Anzahl der Listener für das angegebene Ereignis zurück

eventNames

Abfrage des Ereignisnamens des Listeners

1
Array WebSocket.eventNames();

Ergebnis zurückgeben:

Array, Gibt ein Array von Ereignisnamen zurück

emit

Ein Ereignis aktiv auslösen

1
2
Boolean WebSocket.emit(String ev,
    ...args);

Aufrufparameter:

ev: String, Ereignisname
args: ..., Event-Parameter, die an den Event-Handler übergeben werden

Ergebnis zurückgeben:

Boolean, Rückkehr zum Ereignis-Trigger-Zustand, true zurückgeben, wenn ein Antwortereignis vorliegt, ansonsten false zurückgeben

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 WebSocket.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 WebSocket.toJSON(String key = "");

Aufrufparameter:

key: String, unbenutzt

Ergebnis zurückgeben:

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

Entwicklungsleitfaden

Basismodul

Eingebaute Objekte

Community-Modul

Objekt WebSocket

Erbe

Konstrukteur

WebSocket

Statische Eigenschaften

defaultMaxListeners

Mitgliedsattribute

url

protocol

origin

readyState

onopen

onmessage

onclose

onerror

Mitgliederfunktion

close

send

ref

unref

on

addListener

prependListener

once

prependOnceListener

off

removeListener

removeAllListeners

setMaxListeners

getMaxListeners

listeners

listenerCount

eventNames

emit

toString

toJSON