github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Expand docs docs for RetryOptions (#2385)

Browse Source 
* Better docs for RetryOptions

* Update sdk/core/azure-core/inc/azure/core/http/policies/policy.hpp

Co-authored-by: Ahson Khan <ahkha@microsoft.com>

Co-authored-by: Anton Kolesnyk <antkmsft@users.noreply.github.com>
Co-authored-by: Ahson Khan <ahkha@microsoft.com>
This commit is contained in:
Anton Kolesnyk 2021-06-03 00:58:29 +00:00 committed by GitHub
parent 4b6b2a40fa
commit bae5f553a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
sdk/core/azure-core/inc/azure/core/http/policies/policy.hpp
View File

@ -59,34 +59,35 @@ namespace Azure { namespace Core { namespace Http { namespace Policies {
};
/**
* @brief HTTP request retry options.
* @brief The set of options that can be specified to influence how retry attempts are made, and a
* failure is eligible to be retried.
* @note See https://azure.github.io/azure-sdk/general_azurecore.html#retry-policy.
*
*/
struct RetryOptions final
{
/**
* @brief Maximum number of attempts to retry.
* @brief The maximum number of retry attempts before giving up.
*
*/
int32_t MaxRetries = 3;
/**
* @brief Mimimum amount of milliseconds between retry attempts.
* @brief The minimum permissible delay between retry attempts.
* @note See https://en.cppreference.com/w/cpp/chrono/duration.
*
*/
std::chrono::milliseconds RetryDelay = std::chrono::seconds(4);
/**
* @brief Mimimum amount of milliseconds between retry attempts.
* @brief The maximum permissible delay between retry attempts.
* @note See https://en.cppreference.com/w/cpp/chrono/duration.
*
*/
std::chrono::milliseconds MaxRetryDelay = std::chrono::minutes(2);
/**
* @brief HTTP status codes to retry on.
* @brief The HTTP status codes that indicate when an operation should be retried.
*
*/
std::set<HttpStatusCode> StatusCodes{