WebTransport: createUnidirectionalStream() 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: Dieses Feature ist verfügbar in Web Workers.

Die createUnidirectionalStream() Methode der WebTransport-Schnittstelle öffnet asynchron einen unidirektionalen Stream.

Die Methode gibt ein Promise zurück, das in ein WritableStream-Objekt aufgelöst wird, welches verwendet werden kann, um Daten zuverlässig an den Server zu schreiben.

"Zuverlässig" bedeutet, dass Übertragung und Reihenfolge der Daten garantiert sind. Dies bietet eine langsamere Bereitstellung (obwohl schneller als mit WebSockets) als Datagramme, ist jedoch in Situationen erforderlich, in denen Zuverlässigkeit und Reihenfolge wichtig sind, wie z.B. in Chat-Anwendungen.

Die relative Reihenfolge, in der die in den erstellten Streams aufgestauten Bytes geleert werden, kann mit der sendOrder-Option angegeben werden. Wenn festgelegt, werden aufgestaute Bytes in Streams mit einer höheren Sendepriorität garantiert vor den aufgestauten Bytes für Streams mit niedrigerer Sendepriorität gesendet. Ist die Ordnungsnummer nicht gesetzt, hängt die Reihenfolge, in der Bytes gesendet werden, von der Implementierung ab. Beachten Sie jedoch, dass selbst wenn Bytes aus Streams mit höherer Sendepriorität zuerst gesendet werden, sie möglicherweise nicht zuerst ankommen.

Syntax

js
createUnidirectionalStream()
createUnidirectionalStream(options)

Parameter

options Optional

Ein Objekt, das die folgenden Eigenschaften haben kann:

sendOrder Optional

Ein ganzzahliger Wert, der die Sendepriorität dieses Streams im Verhältnis zu anderen Streams angibt, für die der Wert festgelegt wurde. Aufgestaute Bytes werden zuerst für Streams geschickt, die einen höheren Wert haben. Ist der Wert nicht gesetzt, hängt die Sendepriorität von der Implementierung ab.

Rückgabewert

Ein Promise, das in ein WebTransportSendStream-Objekt aufgelöst wird (dies ist ein WritableStream).

Ausnahmen

InvalidStateError DOMException

Wird ausgelöst, wenn createUnidirectionalStream() aufgerufen wird, während der WebTransport geschlossen oder fehlgeschlagen ist.

Beispiele

Verwenden Sie die createUnidirectionalStream()-Methode, um eine Referenz zu einem WritableStream zu erhalten. Von diesem können Sie einen Writer abrufen, um Daten in den Stream zu schreiben und an den Server zu senden.

Verwenden Sie die close()-Methode des resultierenden WritableStreamDefaultWriter, um die zugehörige HTTP/3-Verbindung zu schließen. Der Browser versucht, alle ausstehenden Daten zu senden, bevor er die zugehörige Verbindung tatsächlich schließt.

js
async function writeData() {
  const stream = await transport.createUnidirectionalStream({
    sendOrder: "596996858",
  });
  const writer = stream.writable.getWriter();
  const data1 = new Uint8Array([65, 66, 67]);
  const data2 = new Uint8Array([68, 69, 70]);
  writer.write(data1);
  writer.write(data2);

  try {
    await writer.close();
    console.log("All data has been sent.");
  } catch (error) {
    console.error(`An error occurred: ${error}`);
  }
}

Sie können auch WritableStreamDefaultWriter.abort() verwenden, um den Stream abrupt zu beenden. Bei der Verwendung von abort() kann der Browser alle ausstehenden Daten verwerfen, die noch nicht gesendet wurden.

js
// ...

const stream = await transport.createUnidirectionalStream();
const writer = ws.getWriter();

// ...

writer.write(...);
writer.write(...);
await writer.abort();
// Not all the data may have been written.

Spezifikationen

Specification
WebTransport
# dom-webtransport-createunidirectionalstream

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch