* Improving Retry-After API doc

* PR
This commit is contained in:
Jason Sandlin 2022-10-11 15:55:59 -07:00 коммит произвёл GitHub
Родитель 75dc4785c9
Коммит e6a5cd2bc6
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 4 добавлений и 4 удалений

Просмотреть файл

@ -446,7 +446,7 @@ STDAPI HCHttpCallRequestSetRetryAllowed(
/// ID number of this REST endpoint used to cache the Retry-After header for fast fail.
/// </summary>
/// <param name="call">The handle of the HTTP call. Pass nullptr to set the default for future calls.</param>
/// <param name="retryAfterCacheId">ID number of this REST endpoint used to cache the Retry-After header for fast fail. 1-1000 are reserved for XSAPI.</param>
/// <param name="retryAfterCacheId">ID number of this REST endpoint used to cache the Retry-After header for fast fail. Must be non-zero. 1-1000 are reserved for XSAPI.</param>
/// <returns>Result code for this API operation. Possible values are S_OK, or E_FAIL.</returns>
/// <remarks>This must be called prior to calling HCHttpCallPerformAsync.</remarks>
STDAPI HCHttpCallRequestSetRetryCacheId(
@ -482,9 +482,9 @@ STDAPI HCHttpCallRequestSetTimeout(
/// The delay is also jittered between the current and next delay to spread out service load.
/// The default for the HTTP timeout window is 20 seconds and can be changed using HCSettingsSetTimeoutWindow()<br />
/// <br />
/// If the service returns an HTTP error with a "Retry-After" header, then all future calls to that API
/// will immediately fail with the original error without contacting the service until the "Retry-After"
/// time has been reached.<br />
/// If the service returns an HTTP error with a "Retry-After" header and the title had previously called
/// HCHttpCallRequestSetRetryCacheId(), then all future calls to that API will immediately fail with the
/// original error without contacting the service until the "Retry-After" time has been reached.<br />
/// <br />
/// Idempotent service calls are retried when a network error occurs or the server responds with<br />
/// one of these HTTP status codes:<br />