WebTransportDatagramDuplexStream: incomingMaxBufferedDatagrams property

Value

An integer.

The initial value is defined by the browser. Setting the property to 0 sets it to 1.

Description

Datagrams received from the server are held in a queue until they are read from the readable stream. If more datagrams arrive than the queue can hold, the oldest datagrams in the queue are dropped to make room for the new ones. The browser doesn't notify your application when datagrams are dropped. The number of incoming datagrams dropped because the queue was full is reported in the droppedIncoming property of the datagram statistics returned by WebTransport.getStats(). If this number keeps growing, increase this value or read datagrams from the stream more often.

This property replaces the deprecated incomingHighWaterMark property.

Examples

Setting the maximum number of buffered incoming datagrams

This example sets the incoming queue to hold up to 100 datagrams, and then logs the value.

const url = "https://example.com:4999/wt";

async function initTransport(url) {
  // Initialize transport connection
  const transport = new WebTransport(url);

  // The connection can be used once ready fulfills
  await transport.ready;

  const datagrams = transport.datagrams;

  // set incomingMaxBufferedDatagrams
  datagrams.incomingMaxBufferedDatagrams = 100;

  // get incomingMaxBufferedDatagrams
  console.log(datagrams.incomingMaxBufferedDatagrams);
}

Specifications

Browser compatibility

See also

• WebTransportDatagramDuplexStream.readable
• WebTransport.getStats()
• WebTransportDatagramDuplexStream.incomingMaxAge
• WebTransportDatagramDuplexStream.outgoingMaxBufferedDatagrams
• Using WebTransport
• Streams API