Skip to content

Commit 074add3

Browse files
jasnellMylesBorins
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 3f801b3 commit 074add3

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
@@ -527,16 +527,28 @@ All other interactions will be routed directly to the socket.
527527
added: v8.4.0
528528
-->
529529

530+
Provides miscellaneous information about the current state of the
531+
`Http2Session`.
532+
530533
* Value: {Object}
531-
* `effectiveLocalWindowSize` {number}
532-
* `effectiveRecvDataLength` {number}
533-
* `nextStreamID` {number}
534-
* `localWindowSize` {number}
535-
* `lastProcStreamID` {number}
536-
* `remoteWindowSize` {number}
537-
* `outboundQueueSize` {number}
538-
* `deflateDynamicTableSize` {number}
539-
* `inflateDynamicTableSize` {number}
534+
* `effectiveLocalWindowSize` {number} The current local (receive)
535+
flow control window size for the `Http2Session`.
536+
* `effectiveRecvDataLength` {number} The current number of bytes
537+
that have been received since the last flow control `WINDOW_UPDATE`.
538+
* `nextStreamID` {number} The numeric identifier to be used the
539+
next time a new `Http2Stream` is created by this `Http2Session`.
540+
* `localWindowSize` {number} The number of bytes that the remote peer can
541+
send without receiving a `WINDOW_UPDATE`.
542+
* `lastProcStreamID` {number} The numeric id of the `Http2Stream`
543+
for which a `HEADERS` or `DATA` frame was most recently received.
544+
* `remoteWindowSize` {number} The number of bytes that this `Http2Session`
545+
may send without receiving a `WINDOW_UPDATE`.
546+
* `outboundQueueSize` {number} The number of frames currently within the
547+
outbound queue for this `Http2Session`.
548+
* `deflateDynamicTableSize` {number} The current size in bytes of the
549+
outbound header compression state table.
550+
* `inflateDynamicTableSize` {number} The current size in bytes of the
551+
inbound header compression state table.
540552

541553
An object describing the current status of this `Http2Session`.
542554

@@ -853,14 +865,21 @@ req.setTimeout(5000, () => req.rstWithCancel());
853865
<!-- YAML
854866
added: v8.4.0
855867
-->
868+
Provides miscellaneous information about the current state of the
869+
`Http2Stream`.
856870

857871
* Value: {Object}
858-
* `localWindowSize` {number}
859-
* `state` {number}
860-
* `localClose` {number}
861-
* `remoteClose` {number}
862-
* `sumDependencyWeight` {number}
863-
* `weight` {number}
872+
* `localWindowSize` {number} The number of bytes the connected peer may send
873+
for this `Http2Stream` without receiving a `WINDOW_UPDATE`.
874+
* `state` {number} A flag indicating the low-level current state of the
875+
`Http2Stream` as determined by nghttp2.
876+
* `localClose` {number} `true` if this `Http2Stream` has been closed locally.
877+
* `remoteClose` {number} `true` if this `Http2Stream` has been closed
878+
remotely.
879+
* `sumDependencyWeight` {number} The sum weight of all `Http2Stream`
880+
instances that depend on this `Http2Stream` as specified using
881+
`PRIORITY` frames.
882+
* `weight` {number} The priority weight of this `Http2Stream`.
864883

865884
A current state of this `Http2Stream`.
866885

0 commit comments

Comments
 (0)