WebTransport: closed-Eigenschaft

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 schreibgeschützte closed-Eigenschaft des WebTransport-Interfaces gibt ein Promise zurück, das aufgelöst wird, wenn der Transport geschlossen wird.

Dieses Promise wird erstellt, wenn das WebTransport-Objekt erstellt wird und wird aufgelöst, wenn der Transport auf irgendeine Weise geschlossen wird, beispielsweise durch Aufruf der close()-Methode, wenn die Verbindung fehlgeschlagen ist oder wenn die Verbindung vom Server geschlossen wird. Der Zugriff auf dieses Promise oder das Abwarten darauf löst keine Aktion aus; es ermöglicht lediglich Maßnahmen zu ergreifen, wenn der Transport geschlossen wird, ähnlich dem Lauschen auf ein Ereignis.

Wert

Ein Promise, das auf ein Objekt mit den folgenden Eigenschaften aufgelöst wird:

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.

Oder, im Falle eines unerwarteten Schließens, wie bei einem Netzwerkfehler, wird das Promise mit einem Fehler abgelehnt.

Beispiele

js
const url = "https://example.com:4999/wt";

async function initTransport(url) {
  // Initialize transport connection
  const transport = new WebTransport(url);

  // The connection can be used once ready fulfills
  await transport.ready;

  // ...
}

// ...

async function closeTransport(transport) {
  // Respond to connection closing
  try {
    await transport.closed;
    console.log(`The HTTP/3 connection to ${url} closed gracefully.`);
  } catch (error) {
    console.error(`The HTTP/3 connection to ${url} closed due to ${error}.`);
  }
}

Spezifikationen

Specification
WebTransport
# dom-webtransport-closed

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch