docs: mention ReadBufferEachConn and WriteBufferEachConn in memory considerations #904
Conversation
This file contains hidden or 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
…nsiderations Signed-off-by: AvinashAbbigeri <[email protected]>
|
This PR adds documentation for ReadBufferEachConn and WriteBufferEachConn under the Memory Consumption Consideration section, as requested in #885. |
|
Cool! But could you keep other irrelevant parts unchanged? |
Signed-off-by: AvinashAbbigeri <[email protected]>
|
Can you check once now? |
rueian
reviewed
Sep 23, 2025
Comment on lines
+430
to
+436
| In addition, each connection also allocates read and write buffers to reduce system calls during high concurrency | ||
| or large pipelines. These buffers are controlled by: | ||
|
|
||
| - `ClientOption.ReadBufferEachConn` (default: 0.5 MiB) | ||
| - `ClientOption.WriteBufferEachConn` (default: 0.5 MiB) | ||
|
|
||
| You can adjust these values in memory-sensitive environments to lower memory usage, at the cost of potential throughput. |
There was a problem hiding this comment.
Could you keep only this part? Others, including the example, are not necessary.
There was a problem hiding this comment.
Why do you want to change these?
Can you revert them?
Signed-off-by: AvinashAbbigeri <[email protected]>
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.
This PR updates the README to document the memory usage of per-connection read and write buffers.
ClientOption.ReadBufferEachConn(default: 0.5 MiB)ClientOption.WriteBufferEachConn(default: 0.5 MiB)Closes #885