Objekt WebSocket

Konvertierungsprozessor für das WebSocket-Paketprotokoll

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 = "");

Parameter aufrufen:

url : String, geben Sie den verbundenen Server an
protocol : Zeichenfolge, geben Sie das Handshake-Protokoll an, der Standardwert ist ""
origin : String, gibt den origin , der während des Handshakes simuliert wurde. Der Standardwert ist ""

WebSocket-Konstruktor

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

Parameter aufrufen:

url : String, geben Sie den verbundenen Server an
opts : Object, Anschlussmöglichkeiten, ist die Standardeinstellung {}

opts enthält zusätzliche angeforderte Optionen und der unterstützte Inhalt lautet 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

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

1
static Integer WebSocket.defaultMaxListeners;

Mitgliedsattribute

url

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

1
readonly String WebSocket.url;

protocol

String, fragen Sie das Protokoll ab, wenn das aktuelle Objekt verbunden ist

1
readonly String WebSocket.protocol;

origin

String, fragen Sie die Quelle der aktuellen Objektverbindung ab

1
readonly String WebSocket.origin;

readyState

Ganzzahl, ws den Verbindungsstatus des aktuellen Objekts ab, siehe ws

1readonly Integer WebSocket.readyState;

onopen

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

1
Function WebSocket.onopen;

onmessage

Funktionieren, abfragen und binden Sie das Ereignis des Empfangs der Nachricht des anderen Teilnehmers, entsprechend on ("message", func);

1
Function WebSocket.onmessage;

onclose

Funktion, Abfrage und Bindung des Ereignisses des Verbindungsabbruchs, äquivalent zu on ("close", func);

1
Function WebSocket.onclose;

onerror

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

1
Function WebSocket.onerror;

Mitgliedsfunktion

close

Schließen Sie die aktuelle Verbindung. Dieser Vorgang sendet ein CLOSE-Paket an die andere Partei und wartet, bis die andere Partei antwortet

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

Parameter aufrufen:

code : Integer, 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 einen Text an die andere Partei

1
WebSocket.send(String data);

Parameter aufrufen:

data : String, geben Sie den gesendeten Text an

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

1WebSocket.send(Buffer data);

Parameter aufrufen:

data : Buffer , geben Sie die gesendeten 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 , geben Sie das aktuelle Objekt zurück

unref

Lassen Sie den fibjs-Prozess beenden und lassen Sie den fibjs-Prozess während der Objektbindung beenden

1WebSocket WebSocket.unref();

Ergebnis zurückgeben:

WebSocket , geben Sie das aktuelle Objekt zurück

on

Binden Sie einen Ereignishandler an das Objekt

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

Binden Sie einen Ereignishandler an das Objekt

1
Object WebSocket.on(Object map);

Parameter aufrufen:

map : Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname ist der Ereignisname und der Eigenschaftswert ist die Ereignisverarbeitungsfunktion

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

addListener

Binden Sie einen Ereignishandler an das Objekt

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

Binden Sie einen Ereignishandler an das Objekt

1
Object WebSocket.addListener(Object map);

Parameter aufrufen:

map : Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname ist der Ereignisname und der Eigenschaftswert ist die Ereignisverarbeitungsfunktion

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

prependListener

Binden Sie einen Ereignishandler an den Objektstart

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

Binden Sie einen Ereignishandler an den Objektstart

1
Object WebSocket.prependListener(Object map);

Parameter aufrufen:

map : Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname ist der Ereignisname und der Eigenschaftswert ist die Ereignisverarbeitungsfunktion

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

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);

Parameter aufrufen:

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

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

Binden Sie eine einmalige Ereignisverarbeitungsfunktion an das Objekt. Die einmalige Verarbeitungsfunktion wird nur einmal ausgelöst

1
Object WebSocket.once(Object map);

Parameter aufrufen:

map : Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname ist der Ereignisname und der Eigenschaftswert ist die Ereignisverarbeitungsfunktion

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

prependOnceListener

Binden Sie einen Ereignishandler an den Objektstart

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

Binden Sie einen Ereignishandler an den Objektstart

1
Object WebSocket.prependOnceListener(Object map);

Parameter aufrufen:

map : Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname ist der Ereignisname und der Eigenschaftswert ist die Ereignisverarbeitungsfunktion

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

off

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

Brechen Sie alle Funktionen in der Objektverarbeitungswarteschlange ab

1
Object WebSocket.off(String ev);

Parameter aufrufen:

ev : String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

1
Object WebSocket.off(Object map);

Parameter aufrufen:

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

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

removeListener

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

Brechen Sie alle Funktionen in der Objektverarbeitungswarteschlange ab

1
Object WebSocket.removeListener(String ev);

Parameter aufrufen:

ev : String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

1
Object WebSocket.removeListener(Object map);

Parameter aufrufen:

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

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

removeAllListeners

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

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

Parameter aufrufen:

evs : Array, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

Object , gibt das Ereignisobjekt selbst zurück und ist einfach zu verketten

setMaxListeners

Das Standardlimit für die Anzahl der Listener, nur aus Kompatibilitätsgründen

1WebSocket.setMaxListeners(Integer n);

Parameter aufrufen:

n : Ganzzahl, 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 , gibt die Standardgrenzwertnummer zurück

listeners

Array von Listenern für das angegebene Ereignis des Abfrageobjekts

1
Array WebSocket.listeners(String ev);

Parameter aufrufen:

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);

Parameter aufrufen:

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

Name des Abfrage-Listener-Ereignisses

1
Array WebSocket.eventNames();

Ergebnis zurückgeben:

Array , gibt ein Array von Ereignisnamen zurück

emit

Aktiv ein Ereignis auslösen

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

Parameter aufrufen:

ev : String, Ereignisname
args : ..., Ereignisparameter, die an den Ereignishandler übergeben werden

Ergebnis zurückgeben:

Boolean , gibt den Ereignisauslöserstatus zurück, gibt true zurück, wenn ein Antwortereignis vorliegt, andernfalls false

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 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 und gibt im Allgemeinen eine Sammlung lesbarer Attribute zurück, die vom Objekt definiert wurden

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

Parameter aufrufen:

key : String, unbenutzt

Ergebnis zurückgeben:

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

Entwicklungshandbuch

Grundmodul

Eingebaute Objekte

Community-Modul

Objekt WebSocket

Erbe

Konstrukteur

WebSocket

Statische Eigenschaften

defaultMaxListeners

Mitgliedsattribute

url

protocol

origin

readyState

onopen

onmessage

onclose

onerror

Mitgliedsfunktion

close

send

ref

unref

on

addListener

prependListener

once

prependOnceListener

off

removeListener

removeAllListeners

setMaxListeners

getMaxListeners

listeners

listenerCount

eventNames

emit

toString

toJSON