Skip to content

Commit 4b41f24

Browse files
authored
Document how to disable Idle Timeout (#2189)
1 parent 6114da1 commit 4b41f24

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/Settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The following settings are available via registry as well as via [QUIC_SETTINGS]
2727
|------------------------------------|------------|-----------------------------|-------------------|-------------------------------------------------------------------------------------------------------------------------------|
2828
| Max Bytes per Key | uint64_t | MaxBytesPerKey | 274,877,906,944 | Maximum number of bytes to encrypt with a single 1-RTT encryption key before initiating key update. |
2929
| Handshake Idle Timeout | uint64_t | HandshakeIdleTimeoutMs | 10,000 | How long a handshake can idle before it is discarded. |
30-
| Idle Timeout | uint64_t | IdleTimeoutMs | 30,000 | How long a connection can go idle before it is gracefully shut down. |
30+
| Idle Timeout | uint64_t | IdleTimeoutMs | 30,000 | How long a connection can go idle before it is gracefully shut down. 0 to disable timeout |
3131
| Max TLS Send Buffer (Client) | uint32_t | TlsClientMaxSendBuffer | 4,096 | How much client TLS data to buffer. |
3232
| Max TLS Send Buffer (Server) | uint32_t | TlsServerMaxSendBuffer | 8,192 | How much server TLS data to buffer. |
3333
| Stream Receive Window | uint32_t | StreamRecvWindowDefault | 32,768 | Initial stream receive window size. |

docs/api/QUIC_SETTINGS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ How long a handshake can idle before it is discarded.
109109

110110
`IdleTimeoutMs`
111111

112-
How long a connection can go idle before it is gracefully shut down.
112+
How long a connection can go idle before it is gracefully shut down. 0 to disable timeout.
113113

114114
**Default value:** 30,000
115115

0 commit comments

Comments
 (0)