Skip to content

Commit 2da1bd9

Browse files
authored
Merge pull request #460 from theturtle32/codex/expand-description-of-dropconnectiononkeepalivetimeout
Fix keepalive timeout docs
2 parents 6666483 + ef7d7c9 commit 2da1bd9

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/WebSocketServer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ If true, the server will automatically send a ping to all clients every `keepali
5858
**keepaliveInterval** - uint - *Default: 20000*
5959
The interval in milliseconds to send keepalive pings to connected clients.
6060

61-
**dropConnectionOnKeepaliveTimeout** - boolean - *Default: true*
62-
If true, the server will consider any connection that has not received any data within the amount of time specified by `keepaliveGracePeriod` after a keepalive ping has been sent. Ignored if `keepalive` is false.
61+
**dropConnectionOnKeepaliveTimeout** - boolean - *Default: true*
62+
If true, the server will consider any connection that has not received any data within the amount of time specified by `keepaliveGracePeriod` after a keepalive ping has been sent to be dead and will drop the connection once that grace period has elapsed without any incoming data. Ignored if `keepalive` is false.
6363

6464
**keepaliveGracePeriod** - uint - *Default: 10000*
6565
The amount of time to wait after sending a keepalive ping before closing the connection if the connected peer does not respond. Ignored if `keepalive` or `dropConnectionOnKeepaliveTimeout` are false. The grace period timer is reset when any data is received from the client.

0 commit comments

Comments
 (0)