WebTransport: anticipatedConcurrentIncomingBidirectionalStreams property

Value

An integer between 0 and 65535, or null.

The initial value comes from the anticipatedConcurrentIncomingBidirectionalStreams option of the WebTransport() constructor, and is null if that option isn't set.

Exceptions

TypeError

Thrown if the property is set to a value outside the range 0 to 65535.

Description

A server can open only as many bidirectional streams as the browser allows. At the start of a session, the browser always allows the server to open at least 100 bidirectional streams.

Some applications expect the server to have more streams than that open at the same time, for example when the server sends each request to the client on its own stream. Setting this property tells the browser how many streams to expect, so that it can raise its limit in advance. This avoids delays when the server opens many streams at once, because the server doesn't have to wait for the browser to allow more streams. The value is a hint, and setting it doesn't guarantee that the server can open that many streams.

A value of null means that the application gives no hint, and the browser uses its default limit. A value below 100, including 0, doesn't reduce the number of streams that the server can initially open.

You can also set the property after the transport is created. The browser can take the new value into account in its later negotiations with the server.

Examples

Anticipating many streams when connecting

This example creates two transports. The first doesn't set the anticipatedConcurrentIncomingBidirectionalStreams option, so the property is null.

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

const transport = new WebTransport(url);
console.log(transport.anticipatedConcurrentIncomingBidirectionalStreams); // null

The second sets the option to 300, which tells the browser that the application expects the server to have up to 300 bidirectional streams open at once.

const busyTransport = new WebTransport(url, {
  anticipatedConcurrentIncomingBidirectionalStreams: 300,
});
console.log(busyTransport.anticipatedConcurrentIncomingBidirectionalStreams); // 300

Changing the anticipated number of streams

This example raises the anticipated number of streams after the session is ready. An application might do this when it learns that the server will send more streams than it first expected.

const transport = new WebTransport("https://example.com:4999/wt", {
  anticipatedConcurrentIncomingBidirectionalStreams: 300,
});
await transport.ready;

// The application now expects the server to open more streams
transport.anticipatedConcurrentIncomingBidirectionalStreams = 600;
console.log(transport.anticipatedConcurrentIncomingBidirectionalStreams); // 600

Specifications

Browser compatibility

See also

• WebTransport.incomingBidirectionalStreams
• WebTransport.anticipatedConcurrentIncomingUnidirectionalStreams
• WebTransport() constructor
• Using WebTransport