Objekt eingebautes Objekt

Objekt WebSocket

Konvertierungsprozessor für das WebSocket-Paketprotokoll

Wird verwendet, um das HTTP-Protokoll in eine WebSocket-Paketprotokollnachricht zu konvertieren. Erstellt von:

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

Vererbung

Konstruktor

WebSocket

WebSocket-Konstruktor

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

Parameter aufrufen:

  • url : String, geben Sie den Server an, zu dem eine Verbindung hergestellt werden soll
  • protocol : Zeichenfolge, gibt das Handshake-Protokoll an, Standard ist ""
  • origin : String, gibt den origin der Simulation während des Handshakes an, der Standardwert ist ""

WebSocket-Konstruktor

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

Parameter aufrufen:

  • url : String, geben Sie den Server an, zu dem eine Verbindung hergestellt werden soll
  • opts : Objekt, Verbindungsoption, Standard ist {}, die unterstützten Felder sind "Protokoll", "Ursprung", "Header", "httpClient".

Statische Eigenschaft

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

1
readonly 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, das von der Nachricht des anderen Teilnehmers empfangen wurde, entsprechend on ("message", func);

1
Function WebSocket.onmessage;

onclose

Funktionieren, abfragen und binden Sie das Ereignis zum Schließen der Verbindung, entsprechend on ("close", func);

1
Function WebSocket.onclose;

onerror

Funktion, Abfrage und Bindung des Ereignisses des Auftretens eines Fehlers, ä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, gibt den zu schließenden Code an, der zulässige Wert ist 3000-4999 oder 1000, der Standardwert ist 1000
  • reason : String, gibt den Grund für das Schließen an, Standard ist ""

send

Senden Sie einen Text an die andere Partei

1
WebSocket.send(String data);

Parameter aufrufen:

  • data : String, geben Sie den zu sendenden Text an

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

1
WebSocket.send(Buffer data);

Parameter aufrufen:

  • 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

1
WebSocket WebSocket.ref();

Gibt das Ergebnis zurück:

  • WebSocket gibt das aktuelle Objekt zurück

unref

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

1
WebSocket WebSocket.unref();

Gibt das Ergebnis zurück:

  • WebSocket gibt das aktuelle Objekt zurück

on

Binden Sie einen Ereignishandler an ein Objekt

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt die Anzahl der erfolgreichen Bindungen zurück oder 0, wenn die Funktion gebunden ist

Binden Sie einen Ereignishandler an ein Objekt

1
Object WebSocket.on(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignishandler verwendet

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

addListener

Binden Sie einen Ereignishandler an ein Objekt

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

Binden Sie einen Ereignishandler an ein Objekt

1
Object WebSocket.addListener(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignishandler verwendet

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

prependListener

Binden Sie einen Ereignishandler an den Anfang des Objekts

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt die Anzahl der erfolgreichen Bindungen zurück oder 0, wenn die Funktion gebunden ist

Binden Sie einen Ereignishandler an den Anfang des Objekts

1
Object WebSocket.prependListener(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignishandler verwendet

Gibt das Ergebnis zurück:

  • Object , gibt die Anzahl der erfolgreichen Bindungen zurück oder 0, wenn die Funktion gebunden ist

once

Binden Sie einen einmaligen Ereignishandler an ein Objekt. Der einmalige Handler wird nur einmal ausgelöst.

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

Binden Sie einen einmaligen Ereignishandler an ein Objekt. Der einmalige Handler wird nur einmal ausgelöst.

1
Object WebSocket.once(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignishandler verwendet

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

prependOnceListener

Binden Sie einen Ereignishandler an den Anfang des Objekts

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt die Anzahl der erfolgreichen Bindungen zurück oder 0, wenn die Funktion gebunden ist

Binden Sie einen Ereignishandler an den Anfang des Objekts

1
Object WebSocket.prependOnceListener(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignishandler verwendet

Gibt das Ergebnis zurück:

  • Object , gibt die Anzahl der erfolgreichen Bindungen zurück oder 0, wenn die Funktion gebunden ist

off

Nicht spezifizierte Funktion aus der Objektverarbeitungswarteschlange

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

Brechen Sie alle Funktionen in der Objektverarbeitungswarteschlange ab

1
Object WebSocket.off(String ev);

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

Nicht spezifizierte Funktion aus der Objektverarbeitungswarteschlange

1
Object WebSocket.off(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

removeListener

Nicht spezifizierte Funktion aus der Objektverarbeitungswarteschlange

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

Brechen Sie alle Funktionen in der Objektverarbeitungswarteschlange ab

1
Object WebSocket.removeListener(String ev);

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

Nicht spezifizierte Funktion aus der Objektverarbeitungswarteschlange

1
Object WebSocket.removeListener(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

removeAllListeners

Brechen Sie alle Listener für alle Ereignisse aus der Objektverarbeitungswarteschlange ab. Wenn ein Ereignis angegeben ist, entfernen Sie alle Listener für das angegebene Ereignis.

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

Parameter aufrufen:

  • evs : Array, geben Sie den Namen des Ereignisses an

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

setMaxListeners

Standardmäßig Anzahl der Listener, nur aus Kompatibilitätsgründen

1
WebSocket.setMaxListeners(Integer n);

Parameter aufrufen:

  • n : Ganzzahl, die Anzahl der angegebenen Ereignisse

getMaxListeners

Holen Sie sich die Standardbegrenzung für Listener, nur aus Kompatibilitätsgründen

1
Integer WebSocket.getMaxListeners();

Gibt das Ergebnis zurück:

  • Integer , gibt die Standardgrenzwertnummer zurück

listeners

Das Listener-Array für das angegebene Ereignis des Abfrageobjekts

1
Array WebSocket.listeners(String ev);

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses

Gibt das Ergebnis zurück:

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

listenerCount

Fragen Sie die Anzahl der Listener für das angegebene Ereignis ab

1
Integer WebSocket.listenerCount(String ev);

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses

Gibt das Ergebnis zurück:

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

eventNames

Abfragen des Listener-Ereignisnamens

1
Array WebSocket.eventNames();

Gibt das Ergebnis zurück:

  • Array , gibt ein Array von Ereignisnamen zurück

emit

Ereignis aktiv auslösen

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

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

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

toString

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

1
String WebSocket.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 WebSocket.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