diff options
| author | Sebastiaan Deckers <sebdeckers83@gmail.com> | 2017-10-25 02:39:06 +0800 |
|---|---|---|
| committer | Anatoli Papirovski <apapirovski@mac.com> | 2017-10-27 10:59:11 -0400 |
| commit | a0f7ae6c4110cca75793964dc9dbbf457071dad8 (patch) | |
| tree | ef5521912c2179eb5c030dfcd0bc75e8cea4a860 /doc | |
| parent | c66e5551dfd6c65a75938155c39975a44bae8be2 (diff) | |
| download | android-node-v8-a0f7ae6c4110cca75793964dc9dbbf457071dad8.tar.gz android-node-v8-a0f7ae6c4110cca75793964dc9dbbf457071dad8.tar.bz2 android-node-v8-a0f7ae6c4110cca75793964dc9dbbf457071dad8.zip | |
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 <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/http2.md | 7 |
1 files 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]]) <!-- YAML added: v8.4.0 |