This repository has been archived by the owner on Aug 29, 2023. It is now read-only.
fix: destroy sockets on close #204
Merged
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
We call `.end` on a socket and wait for the `close` event, but calling `.end` only closes the writable end of the socket. To close both ends we either need to wait for the remote to close their writable end or we need to `.destroy` our socket. If we call `.destroy` all data is lost and no more I/O occurs. The change here is to call `.end` then check to see if we have any outgoing writes, if we do, wait for the `drain` event which means the outgoing data has been sent, then call `.destroy`, otherwise call `.destroy` immediately. At the same time use a timer to call `.destroy` if the `drain` event never arrives. It also set up the `timeout` event for the socket to allow closing the socket after a period of inactivity. Three new constructor options are added to control the behvaiour: - `inboundSocketInactivityTimeout` the socket will be closed after this many ms of not sending/recieving data (default 30s) - `outboundSocketInactivityTimeout` the socket will be closed after this many ms of not sending/recieving data (default 30s) - `socketCloseTimeout` how long to wait for the `drain` event (default 2s) Fixes #201
mpetrunic
approved these changes
Aug 31, 2022
mpetrunic
approved these changes
Aug 31, 2022
|
🎉 This PR is included in version 3.0.5 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
When closing a
MultiaddrConnectionWe call.endon the underlying TCP socket and wait for thecloseevent, but calling.endonly closes the writable end of the socket, not the whole thing.To close both ends we either need to wait for the remote to close their writable end or we need to
.destroyour socket. If we call.destroyall data is lost and no more I/O occurs.The change here is to call
.endthen check to see if we have any outgoing writes, if we do, wait for thedrainevent which means the outgoing data has been sent, then call.destroy, otherwise call.destroyimmediately.At the same time use a timer to call
.destroyif thedrainevent never arrives.It also set up the
timeoutevent for the socket to allow closing the socket after a period of inactivity.Three new constructor options are added to control the behaviour:
inboundSocketInactivityTimeoutinbound sockets will be closed after this many ms of not sending/receiving data (default 30s)outboundSocketInactivityTimeoutoutbound sockets will be closed after this many ms of not sending/receiving data (default 30s)socketCloseTimeouthow long to wait for thedrainevent (default 2s)Fixes #201