From: Timo Sirainen Date: Thu, 5 Oct 2023 11:51:27 +0000 (+0300) Subject: lib-http: Clarify auto_redirect, auto_retry and request_max_redirects setting comments X-Git-Tag: 2.4.1~1348 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ac747a8d4c7d9998f7acdcd0f3f8a86b0853614e;p=thirdparty%2Fdovecot%2Fcore.git lib-http: Clarify auto_redirect, auto_retry and request_max_redirects setting comments --- diff --git a/src/lib-http/http-client.h b/src/lib-http/http-client.h index 83502786a8..6598219043 100644 --- a/src/lib-http/http-client.h +++ b/src/lib-http/http-client.h @@ -59,10 +59,14 @@ struct http_client_settings { /* Maximum number of pipelined requests per connection (default = 1) */ unsigned int max_pipelined_requests; - /* FALSE = Don't automatically act upon redirect responses */ + /* FALSE = Don't automatically act upon redirect responses. The + redirects are returned as a regular response. TRUE = Handle + redirects as long as request_max_redirects isn't reached. */ bool auto_redirect; - /* FALSE = Never automatically retry requests */ + /* FALSE = Never automatically retry requests. Explicit + http_client_request_try_retry() calls can still retry requests + as long as request_max_attempts isn't reached. */ bool auto_retry; /* FALSE = If we use a proxy, delegate SSL negotiation to proxy, rather @@ -70,7 +74,8 @@ struct http_client_settings { bool ssl_tunnel; /* Maximum number of redirects for a request - (default = 0; redirects refused) + (default = 0; redirects result in + HTTP_CLIENT_REQUEST_ERROR_INVALID_REDIRECT) */ unsigned int request_max_redirects;