Skip to content

Commit 6922e83

Browse files
author
Krish
committed
comments fix
1 parent c7b2986 commit 6922e83

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

include/aws/http/http.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,10 @@ void aws_http_library_init(struct aws_allocator *alloc);
123123
AWS_HTTP_API
124124
void aws_http_library_clean_up(void);
125125

126-
/**
127-
* Helper used downstream to check if the HTTP error codes can be classified
128-
* as transient errors.
126+
/*
127+
* This API provides a recommendation on whether an error code should be considered retryable for transient
128+
* errors like host resolution, sockets, and TLS.
129+
* Note: This is a recommendation only. Retry behavior should be determined based on your specific use case.
129130
*/
130131
AWS_HTTP_API
131132
bool aws_http_error_code_is_retryable(int error_code);

source/http.c

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -556,6 +556,9 @@ void aws_http_fatal_assert_library_initialized(void) {
556556
}
557557
}
558558

559+
/*
560+
* This might need to get updated with more http error codes based on consensus.
561+
*/
559562
bool aws_http_error_code_is_retryable(int error_code) {
560563
switch (error_code) {
561564
case AWS_ERROR_HTTP_CONNECTION_CLOSED:

0 commit comments

Comments
 (0)