Adding a heartbeat to the signalling protocol. #409
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lukehb
reviewed
Jan 19, 2025
| */ | ||
| export class SignallingProtocol extends EventEmitter { | ||
| static get SIGNALLING_VERSION(): string { | ||
| return '1.2.1'; | ||
| } | ||
|
|
||
| static readonly PING_TIMEOUT: number = 30 * 1000; |
There was a problem hiding this comment.
This feels like it should be configurable in:
- frontend PS code
- in SS config
The default seems good, but I can imagine people may have cases where they need it set to other values for some particular reason.
lukehb
reviewed
Jan 19, 2025
| private heartbeatWait(): void { | ||
| // non-initiator only. | ||
| // starts a timer to wait for heartbeat pings. we give it double the ping time to allow some lag | ||
| this.keepalive = setTimeout(this.heartbeatTimeout.bind(this), SignallingProtocol.PING_TIMEOUT * 2); |
There was a problem hiding this comment.
As long as the user can set the value, I feel like it should just timeout to what the users sets, rather than 2*value.
Additionally, I think if the user sets the timeout to zero or a negative value, then no timeout should be set/fired.
lukehb
requested changes
Jan 19, 2025
…otocol level was too troublesome.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relevant components:
Problem statement:
#34
Sometimes a connection between the frontend and signalling server can be broken with no actual close event. With a heartbeat we would be able to timeout a connection and allow the user to retry.
Solution
This just cleans up the ping/pong behaviour to implement it at the protocol level. If these messages don't come through in an expected amount of time the connection is closed and a special timeout event is fired.