Skip to content

Commit

Permalink
doc fix
Browse files Browse the repository at this point in the history
  • Loading branch information
TomAugspurger committed Feb 7, 2025
1 parent 6a7235e commit 774dc58
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions cpp/doxygen/main_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,11 @@ This setting can also be controlled by `defaults::bounce_buffer_size()` and `def

#### HTTP Retries

The behavior when a remote IO read returns a error can be controlled through the `KVIKIO_HTTP_STATUS_CODES` and `KVIKIO_HTTP_MAX_ATTEMPTS` environment variables. `KVIKIO_HTTP_STATUS_CODES` controls the status codes to retry, and `KVIKIO_HTTP_MAX_ATTEMPTS` controls the maximum number of attempts to make before throwing an exception.
The behavior when a remote IO read returns a error can be controlled through the `KVIKIO_HTTP_STATUS_CODES` and `KVIKIO_HTTP_MAX_ATTEMPTS` environment variables.
`KVIKIO_HTTP_STATUS_CODES` controls the status codes to retry, and `KVIKIO_HTTP_MAX_ATTEMPTS` controls the maximum number of attempts to make before throwing an exception.

When a response with a status code in the list of retryable codes is received, KvikIO will wait for some period of time before retrying the request. It will keep retrying until reaching the maximum number of attempts.
When a response with a status code in the list of retryable codes is received, KvikIO will wait for some period of time before retrying the request.
It will keep retrying until reaching the maximum number of attempts.

By default, KvikIO will retry responses with the following status codes:

Expand All @@ -125,7 +127,8 @@ By default, KvikIO will retry responses with the following status codes:
- 503
- 504

KvikIO will, by default, make three attempts per read. Note that if you're reading a large file that has been split into multiple reads through the KvikIO's task size setting, then *each* task will be retried up to the maximum number of attempts.
KvikIO will, by default, make three attempts per read.
Note that if you're reading a large file that has been split into multiple reads through the KvikIO's task size setting, then *each* task will be retried up to the maximum number of attempts.

These settings can also be controlled by `defaults::http_max_attempts()`, `defaults::http_max_attempts_reset()`, `defaults::http_status_codes()`, and `defaults::http_status_codes_reset()`.

Expand Down

0 comments on commit 774dc58

Please sign in to comment.