Skip to content

Commit 48a349e

Browse files
committed
quic: use Number instead of BigInt for more stats
PR-URL: #34262 Reviewed-By: Anna Henningsen <[email protected]>
1 parent 5e769b2 commit 48a349e

File tree

4 files changed

+84
-93
lines changed

4 files changed

+84
-93
lines changed

doc/api/quic.md

Lines changed: 45 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -667,10 +667,9 @@ The `'stream'` event may be emitted multiple times.
667667
added: REPLACEME
668668
-->
669669

670-
* Type: {bigint}
670+
* Type: {number}
671671

672-
A `BigInt` representing the number of retransmissions caused by delayed
673-
acknowledgements.
672+
The number of retransmissions caused by delayed acknowledgements.
674673

675674
#### quicsession.address
676675
<!-- YAML
@@ -716,20 +715,19 @@ representing the reason the peer certificate verification failed.
716715
added: REPLACEME
717716
-->
718717

719-
* Type: {bigint}
718+
* Type: {number}
720719

721-
A `BigInt` representing the total number of bidirectional streams
722-
created for this `QuicSession`.
720+
The total number of bidirectional streams created for this `QuicSession`.
723721

724722
#### quicsession.blockCount
725723
<!-- YAML
726724
added: REPLACEME
727725
-->
728726

729-
* Type: {bigint}
727+
* Type: {number}
730728

731-
A `BigInt` representing the total number of times the `QuicSession` has
732-
been blocked from sending stream data due to flow control.
729+
The total number of times the `QuicSession` has been blocked from sending
730+
stream data due to flow control.
733731

734732
Such blocks indicate that transmitted stream data is not being consumed
735733
quickly enough by the connected peer.
@@ -749,18 +747,18 @@ to the connected peer.
749747
added: REPLACEME
750748
-->
751749

752-
* Type: {bigint}
750+
* Type: {number}
753751

754-
A `BigInt` representing the total number of bytes received from the peer.
752+
The total number of bytes received from the peer.
755753

756754
#### quicsession.bytesSent
757755
<!-- YAML
758756
added: REPLACEME
759757
-->
760758

761-
* Type: {bigint}
759+
* Type: {number}
762760

763-
A `BigInt` representing the total number of bytes sent to the peer.
761+
The total number of bytes sent to the peer.
764762

765763
#### quicsession.cipher
766764
<!-- YAML
@@ -831,9 +829,9 @@ Set to `true` if the `QuicSession` has been destroyed.
831829
added: REPLACEME
832830
-->
833831

834-
* Type: {bigint}
832+
* Type: {number}
835833

836-
A `BigInt` representing the length of time the `QuicSession` was active.
834+
The length of time the `QuicSession` was active.
837835

838836
#### quicsession.getCertificate()
839837
<!-- YAML
@@ -902,9 +900,9 @@ Set to `true` when the TLS handshake completion has been confirmed.
902900
added: REPLACEME
903901
-->
904902

905-
* Type: {bigint}
903+
* Type: {number}
906904

907-
A `BigInt` representing the length of time taken to complete the TLS handshake.
905+
The length of time taken to complete the TLS handshake.
908906

909907
#### quicsession.idleTimeout
910908
<!-- YAML
@@ -920,17 +918,16 @@ Set to `true` if the `QuicSession` was closed due to an idle timeout.
920918
added: REPLACEME
921919
-->
922920

923-
* Type: {bigint}
921+
* Type: {number}
924922

925-
A `BigInt` representing the number of key update operations that have
926-
occured.
923+
The number of key update operations that have occured.
927924

928925
#### quicsession.latestRTT
929926
<!-- YAML
930927
added: REPLACEME
931928
-->
932929

933-
* Type: {bigint}
930+
* Type: {number}
934931

935932
The most recently recorded RTT for this `QuicSession`.
936933

@@ -939,10 +936,10 @@ The most recently recorded RTT for this `QuicSession`.
939936
added: REPLACEME
940937
-->
941938

942-
* Type: {bigint}
939+
* Type: {number}
943940

944-
A `BigInt` representing the number of lost-packet retransmissions that have been
945-
performed on this `QuicSession`.
941+
The number of lost-packet retransmissions that have been performed on
942+
this `QuicSession`.
946943

947944
#### quicsession.maxDataLeft
948945
<!-- YAML
@@ -959,10 +956,9 @@ send to the connected peer.
959956
added: REPLACEME
960957
-->
961958

962-
* Type: {bigint}
959+
* Type: {number}
963960

964-
A `BigInt` representing the maximum number of in-flight bytes recorded
965-
for this `QuicSession`.
961+
The maximum number of in-flight bytes recorded for this `QuicSession`.
966962

967963
#### quicsession.maxStreams
968964
<!-- YAML
@@ -983,7 +979,7 @@ of the `QuicSession` as the connected peer allows new streams to be created.
983979
added: REPLACEME
984980
-->
985981

986-
* Type: {bigint}
982+
* Type: {number}
987983

988984
The minimum RTT recorded so far for this `QuicSession`.
989985

@@ -1025,10 +1021,9 @@ of the `ping()` operation.
10251021
added: REPLACEME
10261022
-->
10271023

1028-
* Type: {bigint}
1024+
* Type: {number}
10291025

1030-
A `BigInt` representing the total number of `QuicStreams` initiated by the
1031-
connected peer.
1026+
The total number of `QuicStreams` initiated by the connected peer.
10321027

10331028
#### quicsession.qlog
10341029
<!-- YAML
@@ -1061,10 +1056,9 @@ An object containing the remote address information for the connected peer.
10611056
added: REPLACEME
10621057
-->
10631058

1064-
* Type: {bigint}
1059+
* Type: {number}
10651060

1066-
A `BigInt` representing the total number of `QuicStream` instances initiated
1067-
by this `QuicSession`.
1061+
The total number of `QuicStream` instances initiated by this `QuicSession`.
10681062

10691063
#### quicsession.servername
10701064
<!-- YAML
@@ -1080,7 +1074,7 @@ The SNI servername requested for this session by the client.
10801074
added: REPLACEME
10811075
-->
10821076

1083-
* Type: {bigint}
1077+
* Type: {number}
10841078

10851079
The modified RTT calculated for this `QuicSession`.
10861080

@@ -1107,10 +1101,9 @@ True if the `QuicSession` was closed due to QUIC stateless reset.
11071101
added: REPLACEME
11081102
-->
11091103

1110-
* Type: {bigint}
1104+
* Type: {number}
11111105

1112-
A `BigInt` representing the total number of unidirectional streams
1113-
created on this `QuicSession`.
1106+
The total number of unidirectional streams created on this `QuicSession`.
11141107

11151108
#### quicsession.updateKey()
11161109
<!-- YAML
@@ -2123,20 +2116,18 @@ Set to `true` if the `QuicStream` is bidirectional.
21232116
added: REPLACEME
21242117
-->
21252118

2126-
* Type: {bigint}
2119+
* Type: {number}
21272120

2128-
A `BigInt` representing the total number of bytes received for this
2129-
`QuicStream`.
2121+
The total number of bytes received for this `QuicStream`.
21302122

21312123
#### quicstream.bytesSent
21322124
<!-- YAML
21332125
added: REPLACEME
21342126
-->
21352127

2136-
* Type: {bigint}
2128+
* Type: {number}
21372129

2138-
A `BigInt` representing the total number of bytes sent by this
2139-
`QuicStream`.
2130+
The total number of bytes sent by this `QuicStream`.
21402131

21412132
#### quicstream.clientInitiated
21422133
<!-- YAML
@@ -2182,19 +2173,18 @@ TBD
21822173
added: REPLACEME
21832174
-->
21842175

2185-
* Type: {bigint}
2176+
* Type: {number}
21862177

2187-
A `BigInt` representing the length of time the `QuicStream` has been active.
2178+
The length of time the `QuicStream` has been active.
21882179

21892180
#### quicstream.finalSize
21902181
<!-- YAML
21912182
added: REPLACEME
21922183
-->
21932184

2194-
* Type: {bigint}
2185+
* Type: {number}
21952186

2196-
A `BigInt` specifying the total number of bytes successfully received by the
2197-
`QuicStream`.
2187+
The total number of bytes successfully received by the `QuicStream`.
21982188

21992189
#### quicstream.id
22002190
<!-- YAML
@@ -2210,29 +2200,27 @@ The numeric identifier of the `QuicStream`.
22102200
added: REPLACEME
22112201
-->
22122202

2213-
* Type: {bigint}
2203+
* Type: {number}
22142204

2215-
A `BigInt` representing the highest acknowledged data offset received
2216-
for this `QuicStream`.
2205+
The highest acknowledged data offset received for this `QuicStream`.
22172206

22182207
#### quicstream.maxExtendedOffset
22192208
<!-- YAML
22202209
added: REPLACEME
22212210
-->
22222211

2223-
* Type: {bigint}
2212+
* Type: {number}
22242213

2225-
A `BigInt` representing the maximum extended data offset that has been
2226-
reported to the connected peer.
2214+
The maximum extended data offset that has been reported to the connected peer.
22272215

22282216
#### quicstream.maxReceivedOffset
22292217
<!-- YAML
22302218
added: REPLACEME
22312219
-->
22322220

2233-
* Type: {bigint}
2221+
* Type: {number}
22342222

2235-
A `BigInt` representing the maximum received offset for this `QuicStream`.
2223+
The maximum received offset for this `QuicStream`.
22362224

22372225
#### quicstream.pending
22382226
<!-- YAML

0 commit comments

Comments
 (0)