Commit a7540d5
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: #16451
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>1 parent aaacddb commit a7540d5
1 file changed
Lines changed: 4 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -989,9 +989,6 @@ added: v8.4.0 | |||
| 989 | 989 | Defaults to `false`. | |
| 990 | 990 | * `parent` {number} Specifies the numeric identifier of a stream the newly | |
| 991 | 991 | created stream is dependent on. | |
| 992 | - * `weight` {number} Specifies the relative dependency of a stream in relation | ||
| 993 | - to other streams with the same `parent`. The value is a number between `1` | ||
| 994 | - and `256` (inclusive). | ||
| 995 | 992 | * `callback` {Function} Callback that is called once the push stream has been | |
| 996 | 993 | initiated. | |
| 997 | 994 | * Returns: {undefined} | |
@@ -1012,6 +1009,10 @@ server.on('stream', (stream) => { | |||
| 1012 | 1009 | }); | |
| 1013 | 1010 | ``` | |
| 1014 | 1011 | ||
| 1012 | + Setting the weight of a push stream is not allowed in the `HEADERS` frame. Pass | ||
| 1013 | + a `weight` value to `http2stream.priority` with the `silent` option set to | ||
| 1014 | + `true` to enable server-side bandwidth balancing between concurrent streams. | ||
| 1015 | + | ||
| 1015 | 1016 | #### http2stream.respond([headers[, options]]) | |
| 1016 | 1017 | <!-- YAML | |
| 1017 | 1018 | added: v8.4.0 | |
0 commit comments