Skip to content

Commit f58f69f

Browse files
authored
Clarify readBufferSizeInBytes usage (#5946)
This commit updates the `AwsCrtAsyncHttpClient.Builder#readBufferSizeInBytes` javadoc to mention that this configuration also affects buffering of data from the request content publisher.
1 parent fd47cd6 commit f58f69f

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

http-clients/aws-crt-client/src/main/java/software/amazon/awssdk/http/crt/AwsCrtAsyncHttpClient.java

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,11 +115,15 @@ public interface Builder extends SdkAsyncHttpClient.Builder<AwsCrtAsyncHttpClien
115115
AwsCrtAsyncHttpClient.Builder maxConcurrency(Integer maxConcurrency);
116116

117117
/**
118-
* Configures the number of unread bytes that can be buffered in the
119-
* client before we stop reading from the underlying TCP socket and wait for the Subscriber
120-
* to read more data.
118+
* Configures the number of bytes that can be buffered in the client for sending and receiving data.
119+
* <p>
120+
* For requests, this is the number unsent bytes the client will buffer from the request content publisher until it has to
121+
* wait for the socket to allow more data to be written to it.
122+
* <p>
123+
* When reading responses, this is the number of bytes the client will buffer before we stop reading from the
124+
* underlying TCP socket and wait for the Subscriber to read more data.
121125
*
122-
* @param readBufferSize The number of bytes that can be buffered.
126+
* @param readBufferSize The number of bytes that can be buffered for sending and receiving.
123127
* @return The builder of the method chaining.
124128
*/
125129
AwsCrtAsyncHttpClient.Builder readBufferSizeInBytes(Long readBufferSize);

0 commit comments

Comments
 (0)