Skip to content

add config.keepaliveForce #419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

add config.keepaliveForce #419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0075432
add config.keepaliveForce
gerardo15 Jul 4, 2021
9ed7fef
Add to docs
gerardo15 Jul 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/WebSocketServer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ If true, the server will automatically send a ping to all clients every `keepali
**keepaliveInterval** - uint - *Default: 20000*
The interval in milliseconds to send keepalive pings to connected clients.

**keepaliveForce** - boolean - *Default: false*
if true, the server will not reset the keepalive timer when any data is received from the client, forcing to send the ping on the Interval.

**dropConnectionOnKeepaliveTimeout** - boolean - *Default: true*
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.

Expand Down
4 changes: 3 additions & 1 deletion lib/WebSocketConnection.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,9 @@ WebSocketConnection.prototype.handleGracePeriodTimer = function() {
WebSocketConnection.prototype.handleSocketData = function(data) {
this._debug('handleSocketData');
// Reset the keepalive timer when receiving data of any kind.
this.setKeepaliveTimer();
if (!this.config.keepaliveForce) {
this.setKeepaliveTimer();
}

// Add received data to our bufferList, which efficiently holds received
// data chunks in a linked list of Buffer objects.
Expand Down