Broadcast Channel API

Broadcast Channel-Schnittstelle

Erstellen oder Beitreten eines Kanals

Ein Client tritt einem Broadcast Channel bei, indem er ein BroadcastChannel-Objekt erstellt. Der Konstruktor nimmt einen einzigen Parameter: den Namen des Kanals. Wenn es das erste ist, das sich mit diesem Broadcast-Kanalnamen verbindet, wird der zugrunde liegende Kanal erstellt.

// Connection to a broadcast channel
const bc = new BroadcastChannel("test_channel");

Senden einer Nachricht

Es gengt, die Methode postMessage() auf dem erstellten BroadcastChannel-Objekt aufzurufen, welches jedes Objekt als Argument akzeptiert. Ein Beispiel fr eine Textnachricht:

// Example of sending of a very simple message
bc.postMessage("This is a test message.");

Daten, die an den Kanal gesendet werden, werden mit dem Structured Clone Algorithmus serialisiert. Das bedeutet, dass Sie eine breite Palette von Datenobjekten sicher senden knnen, ohne sie selbst serialisieren zu mssen.

Die API ordnet den Nachrichten keine Semantik zu, daher liegt es an Ihrem Code, zu wissen, welche Art von Nachrichten zu erwarten sind und was damit zu tun ist.

Empfang einer Nachricht

Wenn eine Nachricht gepostet wird, wird ein message-Ereignis an jedes BroadcastChannel-Objekt gesendet, das mit diesem Kanal verbunden ist. Eine Funktion kann fr dieses Ereignis mit dem onmessage-Ereignishandler ausgefhrt werden:

// A handler that only logs the event to the console:
bc.onmessage = (event) => {
  console.log(event);
};

Trennen eines Kanals

Um einen Kanal zu verlassen, rufen Sie die close()-Methode auf dem Objekt auf. Dies trennt das Objekt vom zugrunde liegenden Kanal und ermglicht die Speicherbereinigung.

// Disconnect the channel
bc.close();

Fazit

Das selbstenthaltende Interface der Broadcast Channel API ermglicht die Kommunikation zwischen verschiedenen Kontexten. Es kann verwendet werden, um Benutzeraktionen in anderen Tabs innerhalb desselben Origin zu erkennen, wie wenn der Benutzer sich an- oder abmeldet.

Das Nachrichtenprotokoll ist nicht definiert und die verschiedenen Browsing-Kontexte mssen es selbst implementieren; es gibt keine Aushandlung oder Anforderung von der Spezifikation.

Schnittstellen

BroadcastChannel

Reprsentiert einen benannten Kanal, auf den jeder Browsing-Kontext eines gegebenen Origin zugreifen kann.

Spezifikationen

Browser-Kompatibilitt

Siehe auch

• BroadcastChannel, die Schnittstelle, die es implementiert.