WebTransportDatagramDuplexStream: incomingHighWaterMark property

Deprecated

Avoid using this feature in new projects. This feature may be a candidate for removal from web standards or browsers.

See full compatibility
Learn more

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.

Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.

The incomingHighWaterMark property of the WebTransportDatagramDuplexStream interface represents the maximum number of incoming datagrams that can be queued while waiting to be read from the readable stream. If more datagrams arrive than the queue can hold, the oldest datagrams in the queue are dropped. The number of datagrams dropped this way is reported in the droppedIncoming property of the datagram statistics returned by WebTransport.getStats().

This property has been replaced in the specification by incomingMaxBufferedDatagrams, which should be used instead if supported (see its browser compatibility table).

Value

A number.

Examples

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 incomingHighWaterMark
  datagrams.incomingHighWaterMark = 20000;

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