Skip to content

Commit 960a5b0

Browse files
committed
update doc
1 parent 1d41c4e commit 960a5b0

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The AWS-C-S3 library is an asynchronous AWS S3 client focused on maximizing thro
5050
5151
2. **Maximum Parts Pending Read - `AWS_CRT_S3_MAX_PARTS_PENDING_READ`**
5252
53-
Controls the maximum number of parts that can be pending read from the input stream during a multipart upload. Higher values may improve upload throughput for large files by allowing more parts to be read in parallel, at the cost of higher memory usage.
53+
Controls the maximum number of parts that can be pending read from the input stream during an individual multipart upload. Higher values may improve upload throughput for large files by allowing more parts to be read in parallel, only if the disk read speed can benefit from more concurrent reading of parts.
5454
5555
Example Usage:
5656
@@ -63,10 +63,12 @@ The AWS-C-S3 library is an asynchronous AWS S3 client focused on maximizing thro
6363
6464
**Notes**:
6565
* Only affects multipart uploads. Small files that fit in a single part are not affected.
66+
* If there are multiple parallel multipart upload requests, each upload is limited by the value individually (not cumulatively).
6667
* Setting this too low may introduce delays between reads, as the meta-request waits for the client to schedule more work.
6768
* Setting this too high may cause a single upload to hog work tokens, starving other concurrent uploads.
6869
* The value must be a positive integer (1–4294967295). Invalid or zero values are ignored with a warning, and the default is used.
6970
* The value is read once on first use and cached for the lifetime of the process.
71+
* If the network bandwidth of the device is too low, even a higher value of pending read might not be respected due to having maximum allowed requests in flight.
7072
7173
3. **Test Bucket - `CRT_S3_TEST_BUCKET_NAME`**
7274

0 commit comments

Comments
 (0)