WebTransportDatagramsWritable: sendGroup property

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Web Workers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The sendGroup property of the WebTransportDatagramsWritable interface gets or sets 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.

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(() => {});