Update Documentation for onResponseHeaders Callback (#742)

awslabs · Jan 25, 2024 · 73d4171 · 73d4171
1 parent 75d45bf
commit 73d4171
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/crt/aws-c-io b/crt/aws-c-io
diff --git a/src/main/java/software/amazon/awssdk/crt/s3/S3MetaRequestResponseHandler.java b/src/main/java/software/amazon/awssdk/crt/s3/S3MetaRequestResponseHandler.java
@@ -13,8 +13,9 @@
 public interface S3MetaRequestResponseHandler {
 
     /**
-     * Invoked to provide response headers received during execution of the meta request, both for
-     * success and error HTTP status codes.
+     * Invoked to provide response headers received during the execution of the meta request.
+     * Note: the statusCode in this callback is not the final statusCode. It is possible that the statusCode in `onResponseHeaders`
+     * is 200, and then the request fail leading to a different statusCode in the final `onFinished` callback.
      *
      * @param statusCode statusCode of the HTTP response
      * @param headers the headers received
@@ -31,7 +32,7 @@ default void onResponseHeaders(final int statusCode, final HttpHeader[] headers)
      * Whenever the flow-control window reaches zero, data will stop downloading.
      * To keep data flowing, you must increment the window by returning a number
      * from this method, or by calling {@link S3MetaRequest#incrementReadWindow}.
-     * <p>
+     * </p>
      * If backpressure is disabled, you do not need to maintain the flow-control window,
      * data will arrive as fast as possible.
      *