From 26f9f88a2f3d895137b7b48ab7ab535b4db57b46 Mon Sep 17 00:00:00 2001 From: Sebastiaan Deckers Date: Wed, 25 Oct 2017 02:39:06 +0800 Subject: [PATCH] doc: remove http2 pushStream weight option The PRIORITY field is only supported by HTTP/2 in a HEADERS frame initiated by the client, not in a push request sent by the server. Documents the recommended approach to set a silent priority as used internally by nghttp2. PR-URL: https://github.com/nodejs/node/pull/16451 Reviewed-By: James M Snell Reviewed-By: Colin Ihrig Reviewed-By: Anatoli Papirovski --- doc/api/http2.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index 1272b92052..6e59e81474 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -989,9 +989,6 @@ added: v8.4.0 Defaults to `false`. * `parent` {number} Specifies the numeric identifier of a stream the newly created stream is dependent on. - * `weight` {number} Specifies the relative dependency of a stream in relation - to other streams with the same `parent`. The value is a number between `1` - and `256` (inclusive). * `callback` {Function} Callback that is called once the push stream has been initiated. * Returns: {undefined} @@ -1012,6 +1009,10 @@ server.on('stream', (stream) => { }); ``` +Setting the weight of a push stream is not allowed in the `HEADERS` frame. Pass +a `weight` value to `http2stream.priority` with the `silent` option set to +`true` to enable server-side bandwidth balancing between concurrent streams. + #### http2stream.respond([headers[, options]])