Skip to content
This repository was archived by the owner on Aug 11, 2020. It is now read-only.

Commit 4e9a96e

Browse files
committed
quic: additional doc updates
PR-URL: #213 Reviewed-By: Anna Henningsen <anna@addaleax.net>
1 parent 27357d5 commit 4e9a96e

File tree

1 file changed

+113
-0
lines changed

1 file changed

+113
-0
lines changed

doc/api/quic.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1027,6 +1027,44 @@ added: REPLACEME
10271027
Will be `true` if the `QuicSocket` has been successfully bound to the local UDP
10281028
port.
10291029

1030+
#### quicsocket.boundDuration
1031+
<!-- YAML
1032+
added: REPLACEME
1033+
-->
1034+
1035+
* Type: {BigInt}
1036+
1037+
A `BitInt` representing the length of time this `QuicSocket` has been bound
1038+
to a local port.
1039+
1040+
#### quicsocket.bytesReceived
1041+
<!-- YAML
1042+
added: REPLACEME
1043+
-->
1044+
1045+
* Type: {BigInt}
1046+
1047+
A `BitInt` representing the number of bytes received by this `QuicSocket`.
1048+
1049+
#### quicsocket.bytesSent
1050+
<!-- YAML
1051+
added: REPLACEME
1052+
-->
1053+
1054+
* Type: {BigInt}
1055+
1056+
A `BitInt` representing the number of bytes sent by this `QuicSocket`.
1057+
1058+
#### quicsocket.clientSessions
1059+
<!-- YAML
1060+
added: REPLACEME
1061+
-->
1062+
1063+
* Type: {BigInt}
1064+
1065+
A `BitInt` representing the number of client `QuicSession` instances that
1066+
have been associated with this `QuicSocket`.
1067+
10301068
#### quicsocket.close([callback])
10311069
<!-- YAML
10321070
added: REPLACEME
@@ -1199,6 +1237,15 @@ never have reason to call this.
11991237
If `multicastInterface` is not specified, the operating system will attempt to
12001238
drop membership on all valid interfaces.
12011239

1240+
#### quicsocket.duration
1241+
<!-- YAML
1242+
added: REPLACEME
1243+
-->
1244+
1245+
* Type: {BigInt}
1246+
1247+
A `BitInt` representing the length of time this `QuicSocket` has been active,
1248+
12021249
#### quicsocket.fd
12031250
<!-- YAML
12041251
added: REPLACEME
@@ -1320,6 +1367,45 @@ Listen for new peer-initiated sessions.
13201367
If a `callback` is given, it is registered as a handler for the
13211368
`'session'` event.
13221369

1370+
#### quicsocket.listenDuration
1371+
<!-- YAML
1372+
added: REPLACEME
1373+
-->
1374+
1375+
* Type: {BigInt}
1376+
1377+
A `BitInt` representing the length of time this `QuicSocket` has been listening
1378+
for connections.
1379+
1380+
#### quicsocket.packetsIgnored
1381+
<!-- YAML
1382+
added: REPLACEME
1383+
-->
1384+
1385+
* Type: {BigInt}
1386+
1387+
A `BitInt` representing the number of packets received by this `QuicSocket` that
1388+
have been ignored.
1389+
1390+
#### quicsocket.packetsReceived
1391+
<!-- YAML
1392+
added: REPLACEME
1393+
-->
1394+
1395+
* Type: {BigInt}
1396+
1397+
A `BitInt` representing the number of packets successfully received by this
1398+
`QuicSocket`.
1399+
1400+
#### quicsocket.packetsSent
1401+
<!-- YAML
1402+
added: REPLACEME
1403+
-->
1404+
1405+
* Type: {BigInt}
1406+
1407+
A `BitInt` representing the number of packets sent by this `QuicSocket`.
1408+
13231409
#### quicsocket.pending
13241410
<!-- YAML
13251411
added: REPLACEME
@@ -1344,6 +1430,33 @@ added: REPLACEME
13441430
Sets or clears the `SO_BROADCAST` socket option. When set to `true`, UDP
13451431
packets may be sent to a local interface's broadcast address.
13461432

1433+
#### quicsocket.serverSessions
1434+
<!-- YAML
1435+
added: REPLACEME
1436+
-->
1437+
1438+
* Type: {BigInt}
1439+
1440+
A `BitInt` representing the number of server `QuicSession` instances that
1441+
have been associated with this `QuicSocket`.
1442+
1443+
#### quicsocket.setDiagnosticPacketLoss(options)
1444+
<!-- YAML-
1445+
added: REPLACEME
1446+
-->
1447+
1448+
* `options` {Object}
1449+
* `rx` {double} A value in the range `0.0` to `1.0` that specifies the
1450+
probability of received packet loss.
1451+
* `tx` {double} A value in the range `0.0` to `1.0` that specifies the
1452+
probability of transmitted packet loss.
1453+
1454+
The `quicsocket.setDiagnosticPacketLoss()` method is a diagnostic only tool
1455+
that can be used to *simulate* packet loss conditions for this `QuicSocket`
1456+
by artificially dropping received or transmitted packets.
1457+
1458+
This method is *not* to be used in production applications.
1459+
13471460
#### quicsocket.setMulticastLoopback([on])
13481461
<!-- YAML
13491462
added: REPLACEME

0 commit comments

Comments
 (0)