WebTransport

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.

Das WebTransport-Interface der WebTransport-API bietet Funktionalität, die es einem User-Agent ermöglicht, eine Verbindung zu einem HTTP/3-Server herzustellen, einen zuverlässigen und/oder unzuverlässigen Transport in eine oder beide Richtungen zu initiieren und die Verbindung zu schließen, sobald sie nicht mehr benötigt wird.

Konstruktor

WebTransport(): Erstellt eine neue Instanz eines WebTransport-Objekts.

Instanz-Eigenschaften

closed Schreibgeschützt: Gibt ein Promise zurück, das aufgelöst wird, wenn der Transport geschlossen wird.
datagrams Schreibgeschützt: Gibt eine Instanz von WebTransportDatagramDuplexStream zurück, die zum Senden und Empfangen von Datagrammen verwendet werden kann.
congestionControl Schreibgeschützt Experimentell: Gibt einen String zurück, der die Anwendungsvorliebe für entweder hohen Durchsatz oder niedrige Latenz beim Senden von Daten angibt.
incomingBidirectionalStreams Schreibgeschützt: Stellt einen oder mehrere vom Server geöffnete bidirektionale Streams dar. Gibt einen ReadableStream von WebTransportBidirectionalStream-Objekten zurück. Jeder kann verwendet werden, um Daten vom Server zu lesen und Daten zurück zu senden.
incomingUnidirectionalStreams Schreibgeschützt: Stellt einen oder mehrere vom Server geöffnete unidirektionale Streams dar. Gibt einen ReadableStream von WebTransportReceiveStream-Objekten zurück. Jeder kann verwendet werden, um Daten vom Server zu lesen.
ready Schreibgeschützt: Gibt ein Promise zurück, das aufgelöst wird, wenn der Transport bereit zur Nutzung ist.
reliability Schreibgeschützt Experimentell: Gibt einen String zurück, der angibt, ob die Verbindung nur zuverlässige Transporte unterstützt oder ob sie auch unzuverlässige Transporte (wie UDP) unterstützt.

Instanz-Methoden

close(): Schließt eine laufende WebTransport-Sitzung.
createBidirectionalStream(): Öffnet asynchron einen bidirektionalen Stream (WebTransportBidirectionalStream), der zum Lesen vom und Schreiben zum Server verwendet werden kann.
createUnidirectionalStream(): Öffnet asynchron einen unidirektionalen Stream (WritableStream), der zum Schreiben zum Server verwendet werden kann.
getStats() Experimentell: Gibt asynchron ein Promise zurück, das mit einem Objekt erfüllt wird, das HTTP/3-Verbindungsstatistiken enthält.

Beispiele

Das untenstehende Beispiel zeigt, wie Sie eine Verbindung zu einem HTTP/3-Server herstellen, indem Sie dessen URL dem WebTransport()-Konstruktor übergeben. Beachten Sie, dass das Schema HTTPS sein muss und die Portnummer explizit angegeben werden muss. Sobald das WebTransport.ready-Promise erfüllt ist, können Sie die Verbindung nutzen.

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

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

Sie können auf das Schließen der Verbindung reagieren, indem Sie darauf warten, dass das WebTransport.closed-Promise erfüllt wird. Fehler, die von WebTransport-Operationen zurückgegeben werden, sind vom Typ WebTransportError und enthalten zusätzliche Daten zusätzlich zu den Standardsätzen von DOMException.

Die closeTransport()-Methode unten zeigt eine mögliche Implementierung. Innerhalb eines try...catch-Blocks wird await verwendet, um auf die Erfüllung oder Ablehnung des closed-Promises zu warten und dann zu berichten, ob die Verbindung absichtlich oder aufgrund eines Fehlers geschlossen wurde.

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}.`);
  }
}

Wir könnten die oben genannten asynchronen Funktionen in ihrer eigenen asynchronen Funktion aufrufen, wie unten gezeigt.

// Use the transport
async function useTransport(url) {
  const transport = await initTransport(url);

  // Use the transport object to send and receive data
  // …

  // When done, close the transport
  await closeTransport(transport);
}

const url = "https://example.com:4999/wt";
useTransport(url);

Weitere Beispielcodes finden Sie auf den einzelnen Seiten zu Eigenschaften und Methoden.

Spezifikationen

Specification
WebTransport # web-transport