WebSocket: message Ereignis

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

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

Das message Ereignis wird ausgelöst, wenn Daten durch ein WebSocket empfangen werden.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener(), oder setzen Sie eine Ereignis-Handler-Eigenschaft.

js
addEventListener("message", (event) => {});

onmessage = (event) => {};

Ereignistyp

Ein MessageEvent. Erbt von Event.

Event MessageEvent

Ereigniseigenschaften

Zusätzlich zu den unten aufgeführten Eigenschaften sind Eigenschaften der übergeordneten Schnittstelle, Event, verfügbar.

data Schreibgeschützt

Die vom Nachrichtenerzeuger gesendeten Daten. Der Typ dieser Eigenschaft hängt vom Typ der WebSocket-Nachricht und dem Wert von WebSocket.binaryType ab.

  • Wenn der Nachrichtentyp "text" ist, dann ist dieses Feld ein String.
  • Wenn der Nachrichtentyp "binary" ist, dann kann der Typ dieser Eigenschaft aus dem binaryType dieses Sockets abgeleitet werden:
    • ArrayBuffer wenn binaryType "arraybuffer" ist,
    • Blob wenn binaryType "blob" ist. Dieser hat keinen zugeordneten Medientyp (Blob.type ist "").
origin Schreibgeschützt

Ein String, der den Ursprung des Nachrichtenerzeugers darstellt.

Weitere Eigenschaften der MessageEvent-Schnittstelle sind vorhanden, beziehen sich jedoch nicht auf die WebSocket-API und behalten ihre Standardwerte bei:

Beispiele

js
// Create WebSocket connection.
const socket = new WebSocket("ws://localhost:8080");

// Listen for messages
socket.addEventListener("message", (event) => {
  console.log("Message from server ", event.data);
});

Spezifikationen

Specification
WebSockets Standard
# dom-websocket-onmessage

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch