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: Diese Funktion ist in Web Workers verfügbar.
Die createUnidirectionalStream()-Methode der WebTransport-Schnittstelle öffnet asynchron einen unidirektionalen Stream.
Die Methode gibt ein Promise zurück, das sich in ein WritableStream-Objekt auflöst, welches verwendet werden kann, um zuverlässig Daten an den Server zu senden.
"Zuverlässig" bedeutet, dass Übertragung und Reihenfolge der Daten garantiert sind. Dies bietet langsamere Zustellung (wenn auch schneller als mit WebSockets) als datagrams, ist jedoch in Situationen erforderlich, in denen Zuverlässigkeit und Reihenfolge wichtig sind, wie z.B. Chat-Anwendungen.
Die relative Reihenfolge, in der wartende Bytes aus erstellten Streams geleert werden, kann mit der sendOrder-Option angegeben werden. Wenn eingestellt, werden wartende Bytes in Streams mit höherer Sendepriorität garantiert vor den wartenden Bytes in Streams mit niedrigerer Sendepriorität gesendet. Wird die Ordnungsnummer nicht gesetzt, hängt die Reihenfolge, in der die Bytes gesendet werden, von der Implementierung ab. Beachten Sie jedoch, dass selbst wenn Bytes aus Streams höherer Sendepriorität zuerst gesendet werden, sie möglicherweise nicht zuerst ankommen.
Syntax
createUnidirectionalStream()
createUnidirectionalStream(options)
Parameter
optionsOptional-
Ein Objekt, das folgende Eigenschaften haben kann:
sendOrderOptional-
Ein Ganzzahlwert, der die Sendepriorität dieses Streams relativ zu anderen Streams angibt, für die der Wert festgelegt wurde. Wartende Bytes werden zuerst für Streams gesendet, die einen höheren Wert haben. Wenn nicht gesetzt, hängt die Sendereihenfolge von der Implementierung ab.
Rückgabewert
Ein Promise, das sich in ein WebTransportSendStream-Objekt auflöst (dies ist ein WritableStream).
Ausnahmen
InvalidStateErrorDOMException-
Wird ausgelöst, wenn
createUnidirectionalStream()aufgerufen wird, während das 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 Schreiber erhalten, 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 wartenden Daten zu senden, bevor die zugehörige Verbindung tatsächlich geschlossen wird.
async function writeData() {
const stream = await transport.createUnidirectionalStream({
sendOrder: "596996858",
});
const writer = stream.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 Verwendung von abort() kann der Browser alle wartenden Daten verwerfen, die noch nicht gesendet wurden.
// …
const stream = await transport.createUnidirectionalStream();
const writer = stream.getWriter();
// …
writer.write(data1);
writer.write(data2);
await writer.abort();
// Not all the data may have been written.
Spezifikationen
| Specification |
|---|
| WebTransport # dom-webtransport-createunidirectionalstream |