MDN self-hosted library · e01.org

WebTransportDatagramsWritable: sendGroup property

WebTransport API

Open notebook · 1 cells web-api-instance-property upstream source

WebTransport API

The sendGroup property of the WebTransportDatagramsWritable interface represents the WebTransportSendGroup that this WebTransportDatagramsWritable is grouped under for the purposes of sendOrder prioritization.

Within a group, bytes queued for sending on streams and datagrams with a higher sendOrder are sent before any bytes from lower-priority ones. Different groups are expected to be treated as equals for the purposes of bandwidth allocation — though the precise way bandwidth is divided between groups is implementation-defined.

Value

A WebTransportSendGroup object, or null to specify the default send group. The default value is null.

Exceptions

  • InvalidStateError DOMException
  • : Thrown if set to a WebTransportSendGroup that is associated with a different WebTransport object than this stream.

Examples

Basic usage

The example below creates a send group using the WebTransport.createSendGroup() method, and then uses it with a sendOrder value, to prioritize the datagrams written to the stream relative to other streams and datagrams that are part of the same group:

const sendGroup = transport.createSendGroup();

const writable = transport.datagrams.createWritable({
  sendGroup,
  sendOrder: 1,
});

console.log(writable.sendGroup === sendGroup); // true

const writer = writable.getWriter();
const data = new Uint8Array([65, 66, 67]);
await writer.ready;
writer.write(data).catch(() => {});

Specifications

Browser compatibility

See also