WebSocket: WebSocket() Konstruktor

Baseline Weitgehend verfügbar *

Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit Juli 2015 browserübergreifend verfügbar.

* Einige Teile dieser Funktion werden möglicherweise unterschiedlich gut unterstützt.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Der WebSocket() Konstruktor gibt ein neues WebSocket-Objekt zurück und versucht sofort, eine Verbindung zu der angegebenen WebSocket-URL herzustellen.

In diesem Artikel

Die URL des Ziel-WebSocket-Servers, zu dem die Verbindung hergestellt werden soll. Die URL muss eines der folgenden Schemas verwenden: ws, wss, http oder https, und darf kein URL-Fragment enthalten. Wenn eine relative URL angegeben wird, bezieht sie sich auf die Basis-URL des aufrufenden Skripts.

protocols Optional

Ein einzelner String oder ein Array von Strings, die das (die) Subprotokoll(e) repräsentieren, das der Client in Präferenzreihenfolge verwenden möchte. Wenn es weggelassen wird, wird standardmäßig ein leeres Array verwendet, d.h. [].

Ein einzelner Server kann mehrere WebSocket-Subprotokolle implementieren und verschiedene Arten von Interaktionen je nach angegebenem Wert behandeln. Beachten Sie jedoch, dass pro Verbindung nur ein Subprotokoll ausgewählt werden kann.

Die erlaubten Werte sind diejenigen, die im Sec-WebSocket-Protocol HTTP-Header angegeben werden können. Dies sind Werte, die aus dem IANA WebSocket Subprotocol Name Registry ausgewählt werden, wie soap, wamp, ship und so weiter, oder es kann ein benutzerdefinierter Name sein, der sowohl dem Client als auch dem Server bekannt ist.

Hinweis: Die Verbindung wird nicht hergestellt, bis das Subprotokoll mit dem Server ausgehandelt ist. Das ausgewählte Protokoll kann dann von WebSocket.protocol ausgelesen werden: Es wird der leere String sein, wenn keine Verbindung hergestellt werden kann.

Ausnahmen

SyntaxError DOMException

Wird ausgelöst, wenn:

das Parsen von url fehlschlägt
url ein anderes Schema als ws, wss, http oder https hat
url ein Fragment enthält
irgendwelche der Werte in protocols mehr als einmal vorkommen oder sonst wie die Anforderungen an Elemente nicht erfüllen, die den Wert der Sec-WebSocket-Protocol-Felder gemäß der WebSocket-Protokollspezifikation ausmachen

Beispiele

Die folgenden Beispiele zeigen, wie Sie sich mit einem WebSocket verbinden können.

Der untenstehende Code zeigt, wie Sie sich mit einer URL mit dem wss-Schema zu einem Socket verbinden können:

js
const wssWebSocket = new WebSocket("wss://websocket.example.org");
console.log(wssWebSocket.url); // 'wss://websocket.example.org'

// Do something with socket

wssWebSocket.close();

Der Code zum Verbinden mit einer HTTPS-URL ist nahezu identisch. Im Hintergrund löst der Browser dies auf eine "WSS"-Verbindung auf, sodass die WebSocket.url das Schema "wss:" haben wird.

js
const httpsWebSocket = new WebSocket("https://websocket.example.org");
console.log(httpsWebSocket.url); // 'wss://websocket.example.org'

// Do something with socket

httpsWebSocket.close();

Wir können auch relative URLs auflösen. Die absolute URL hängt von der Basis-URL des Kontexts ab, in dem sie aufgerufen wird.

js
relativeWebSocket = new WebSocket("/local/url");

// Do something with socket

relativeWebSocket.close();

RFC 6455 (die WebSocket-Protokollspezifikation)

Help improve MDN

War diese Übersetzung hilfreich?

Ja Nein

Erfahren Sie, wie Sie beitragen können Diese Seite wurde automatisch aus dem Englischen übersetzt.

Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden

WebSocket API (WebSockets)
WebSocket
Konstruktor
1. WebSocket()
Instanzeigenschaften
Instanzmethoden
1. close()
2. send()
Events
Vererbung
1. EventTarget
Verwandte Seiten für WebSockets API
Anleitungen
1. Schreiben von WebSocket-Client-Anwendungen
2. Schreiben von WebSocket-Servern
3. Schreiben eines WebSocket-Servers in C#
4. Einen WebSocket-Server in Java schreiben
5. Schreiben eines WebSocket-Servers in JavaScript (Deno)
6. Verwenden von WebSocketStream, um einen Client zu schreiben

WebSocket: WebSocket() Konstruktor

In diesem Artikel

Syntax

Parameter

Ausnahmen

Beispiele

Spezifikationen

Browser-Kompatibilität

Siehe auch

Help improve MDN