Skip to content

Commit 5ebd017

Browse files
jasnellevanlucas
authored andcommitted
doc: add descriptions of state properties
Fixes: #15268 PR-URL: #18044 Fixes: #15268 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 7911b9b commit 5ebd017

File tree

1 file changed

+34
-15
lines changed

1 file changed

+34
-15
lines changed

doc/api/http2.md

+34-15
Original file line numberDiff line numberDiff line change
@@ -540,16 +540,28 @@ All other interactions will be routed directly to the socket.
540540
added: v8.4.0
541541
-->
542542

543+
Provides miscellaneous information about the current state of the
544+
`Http2Session`.
545+
543546
* Value: {Object}
544-
* `effectiveLocalWindowSize` {number}
545-
* `effectiveRecvDataLength` {number}
546-
* `nextStreamID` {number}
547-
* `localWindowSize` {number}
548-
* `lastProcStreamID` {number}
549-
* `remoteWindowSize` {number}
550-
* `outboundQueueSize` {number}
551-
* `deflateDynamicTableSize` {number}
552-
* `inflateDynamicTableSize` {number}
547+
* `effectiveLocalWindowSize` {number} The current local (receive)
548+
flow control window size for the `Http2Session`.
549+
* `effectiveRecvDataLength` {number} The current number of bytes
550+
that have been received since the last flow control `WINDOW_UPDATE`.
551+
* `nextStreamID` {number} The numeric identifier to be used the
552+
next time a new `Http2Stream` is created by this `Http2Session`.
553+
* `localWindowSize` {number} The number of bytes that the remote peer can
554+
send without receiving a `WINDOW_UPDATE`.
555+
* `lastProcStreamID` {number} The numeric id of the `Http2Stream`
556+
for which a `HEADERS` or `DATA` frame was most recently received.
557+
* `remoteWindowSize` {number} The number of bytes that this `Http2Session`
558+
may send without receiving a `WINDOW_UPDATE`.
559+
* `outboundQueueSize` {number} The number of frames currently within the
560+
outbound queue for this `Http2Session`.
561+
* `deflateDynamicTableSize` {number} The current size in bytes of the
562+
outbound header compression state table.
563+
* `inflateDynamicTableSize` {number} The current size in bytes of the
564+
inbound header compression state table.
553565

554566
An object describing the current status of this `Http2Session`.
555567

@@ -1010,14 +1022,21 @@ req.setTimeout(5000, () => req.rstStream(NGHTTP2_CANCEL));
10101022
<!-- YAML
10111023
added: v8.4.0
10121024
-->
1025+
Provides miscellaneous information about the current state of the
1026+
`Http2Stream`.
10131027

10141028
* Value: {Object}
1015-
* `localWindowSize` {number}
1016-
* `state` {number}
1017-
* `localClose` {number}
1018-
* `remoteClose` {number}
1019-
* `sumDependencyWeight` {number}
1020-
* `weight` {number}
1029+
* `localWindowSize` {number} The number of bytes the connected peer may send
1030+
for this `Http2Stream` without receiving a `WINDOW_UPDATE`.
1031+
* `state` {number} A flag indicating the low-level current state of the
1032+
`Http2Stream` as determined by nghttp2.
1033+
* `localClose` {number} `true` if this `Http2Stream` has been closed locally.
1034+
* `remoteClose` {number} `true` if this `Http2Stream` has been closed
1035+
remotely.
1036+
* `sumDependencyWeight` {number} The sum weight of all `Http2Stream`
1037+
instances that depend on this `Http2Stream` as specified using
1038+
`PRIORITY` frames.
1039+
* `weight` {number} The priority weight of this `Http2Stream`.
10211040

10221041
A current state of this `Http2Stream`.
10231042

0 commit comments

Comments
 (0)