Baseline Widely available *
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.
new WebSocket(url)
new WebSocket(url, protocols)
Parameter
url
Die URL des Ziel-WebSocket-Servers, zu dem verbunden werden soll. Die URL muss eines der folgenden Schemen verwenden: ws
, wss
, http
, oder https
, und darf kein URL-Fragment enthalten. Wenn eine relative URL angegeben wird, ist sie relativ zur Basis-URL des aufrufenden Skripts.
protocols
Optional
Ein einzelner String oder ein Array von Strings, die die Subprotokolle darstellen, die der Client in der Reihenfolge der Präferenz 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 basierend auf dem angegebenen Wert handhaben. Beachten Sie jedoch, dass pro Verbindung nur ein Subprotokoll ausgewählt werden kann.
Die zulässigen Werte sind jene, die im Sec-WebSocket-Protocol
HTTP-Header angegeben werden können. Diese sind Werte, die aus dem IANA WebSocket Subprotocol Name Registry ausgewählt wurden, wie soap
, wamp
, ship
und so weiter, oder können einen benutzerdefinierten Namen haben, der von Client und Server gemeinsam verstanden wird.
Hinweis: Die Verbindung wird nicht hergestellt, bis das Subprotokoll mit dem Server ausgehandelt ist. Das ausgewählte Protokoll kann dann von WebSocket.protocol
abgelesen werden: Es wird der leere String sein, wenn eine Verbindung nicht hergestellt werden kann.
SyntaxError
DOMException
Wird ausgelöst, wenn:
url
fehlschlägturl
ein anderes Schema als ws
, wss
, http
, oder https
haturl
ein Fragment enthältprotocols
mehr als einmal vorkommen oder anderweitig die Anforderungen an die Elemente, die den Wert der Sec-WebSocket-Protocol
-Felder bilden, gemäà der WebSocket-Protokollspezifikation nicht erfüllenDie folgenden Beispiele zeigen, wie Sie eine Verbindung zu einem WebSocket
herstellen könnten.
Der folgende Code zeigt, wie wir eine Verbindung zu einem Socket unter Verwendung einer URL mit dem Schema wss
herstellen können:
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 gleich. Intern löst der Browser dies zu einer âWSSâ-Verbindung auf, sodass die WebSocket.url
das Schema âwss:â haben wird.
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.
relativeWebSocket = new WebSocket("/local/url");
// Do something with socket
relativeWebSocket.close();
Spezifikationen Browser-Kompatibilität Siehe auch
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4