Skip to content

Commit 1ab4fef

Browse files
committed
tweak the word in the documentation
1 parent 849f4d3 commit 1ab4fef

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

include/aws/s3/s3_client.h

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -601,8 +601,11 @@ struct aws_s3_client_config {
601601
* If true, each meta request has a flow-control window that shrinks as
602602
* response body data is downloaded (headers do not affect the window).
603603
* `initial_read_window` determines the starting size of each meta request's window.
604-
* You will stop downloading data whenever the flow-control window reaches 0
605-
* You must call aws_s3_meta_request_increment_read_window() to keep data flowing.
604+
*
605+
* - You will stop receiving response body data whenever the flow-control window reaches 0
606+
* - If the window size remaining is smaller than the part download, client will buffer the part until
607+
* the window opens up to delivery the full part.
608+
* - You must call aws_s3_meta_request_increment_read_window() to keep data flowing.
606609
*
607610
* WARNING: This feature is experimental.
608611
* Currently, backpressure is only applied to GetObject requests which are split into multiple parts,

0 commit comments

Comments
 (0)