WebTransport: close() Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

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

Die close()-Methode der WebTransport-Schnittstelle schließt eine laufende WebTransport-Sitzung.

Syntax

close(info)

Parameter

info Optional

Ein Objekt, das die folgenden Eigenschaften enthält:

closeCode: Eine Zahl, die den Fehlercode für den Fehler darstellt.
reason: Ein String, der den Grund für das Schließen des WebTransport darstellt.

Rückgabewert

undefined.

Ausnahmen

WebTransportError: Wird ausgelöst, wenn close() aufgerufen wird, während der WebTransport sich im Verbindungsprozess befindet.

Beispiele

const url = "https://example.com:4999/wt";
// Initialize transport connection
const transport = new WebTransport(url);

// ...

transport.close({
  closeCode: 017,
  reason: "CloseButtonPressed",
});

Spezifikationen

Specification
WebTransport # dom-webtransport-close

Browser-Kompatibilität

BCD tables only load in the browser