WebTransport: createSendGroup() Methode

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 createSendGroup() Methode der WebTransport Schnittstelle erzeugt und gibt eine WebTransportSendGroup zurück.

Syntax

createSendGroup()

Ausnahmen

InvalidStateError DOMException: Wird ausgelöst, wenn der Zustand des Transports "closed" oder "failed" ist.

Beschreibung

Die createSendGroup() Methode erstellt eine neue WebTransportSendGroup, die mit dem WebTransport-Objekt verknüpft ist, auf dem sie aufgerufen wird.

Das WebTransportSendGroup-Objekt wird verwendet, um Streams und/oder Datagramme zu gruppieren, die auf demselben WebTransport erstellt wurden, um ihre relative Priorität für das Senden von wartenden Bytes zu steuern. Innerhalb derselben Gruppe werden Bytes aus Streams und Datagrammen mit höherer Priorität vor Bytes aus solchen mit niedrigerer Priorität gesendet.

Die zurückgegebene WebTransportSendGroup ist anfänglich nicht mit irgendwelchen Streams oder Datagrammen verknüpft. Sie können sie mit einem WebTransportDatagramsWritable oder WebTransportSendStream-Objekt auf verschiedene Weise verknüpfen:

Indem Sie sie als sendGroup-Option beim Erstellen des Objekts angeben — siehe WebTransport.createUnidirectionalStream(), WebTransport.createBidirectionalStream() und WebTransportDatagramDuplexStream.createWritable().
Indem Sie die sendGroup-Eigenschaft des Objekts danach setzen — siehe WebTransportSendStream.sendGroup und WebTransportDatagramsWritable.sendGroup.

Verschiedene Gruppen sollen für die Zwecke der Bandbreitenverteilung als gleichrangig behandelt werden — obwohl die genaue Art und Weise, wie die Bandbreite zwischen den Gruppen aufgeteilt wird, implementationsbedingt ist.

Beispiele

Grundlegende Verwendung

Dieses Beispiel erstellt eine Send-Gruppe und verknüpft dann einen unidirektionalen Stream und den ausgehenden Datagramm-Stream der Verbindung mit ihr, wobei jedem eine sendOrder zugewiesen wird, die ihre relative Priorität definiert.

const sendGroup = transport.createSendGroup();

const stream = await transport.createUnidirectionalStream({
  sendGroup,
  sendOrder: 1,
});

// Higher sendOrder: queued bytes on this stream are sent first
const datagrams = transport.datagrams.createWritable({
  sendGroup,
  sendOrder: 2,
});