fix: add comment for the readBufferSize and writeBufferSize #869
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
…e params Signed-off-by: rfyiamcool <[email protected]>
|
This PR updates the Upgrader documentation. The upgrader reuses the buffers returned from hijack when the buffer sizes are set to zero. It looks like these buffers are 4096 bytes, but is there any guarantee that the buffers are that size? This PR does not update the Dialer documentation. The dialer does default to a 4096 byte buffer, so it is safe to update that documentation. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #869 +/- ##
=======================================
Coverage 70.20% 70.20%
=======================================
Files 11 11
Lines 1594 1594
=======================================
Hits 1119 1119
Misses 362 362
Partials 113 113 ☔ View full report in Codecov by Sentry. |
AlexVulaj
approved these changes
Dec 7, 2023
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.
summary
😅 Every time I use
gorilla/websocket, I need to look at the source code and find the default size for readBufferSize and writeBufferSize.I think the default value should be written in the comment.