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

make per call and per operation policies public (#1771)

Browse Source
This commit is contained in:
Victor Vazquez 2021-03-04 21:48:44 +00:00 committed by GitHub
parent 813980da8f
commit 92e680b6af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
sdk/core/azure-core/inc/azure/core/internal/client_options.hpp
View File

@ -22,19 +22,28 @@ namespace Azure { namespace Core { namespace Internal {
* and Transport.
*
*/
class ClientOptions {
private:
std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> m_perOperationPolicies;
std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> m_perRetryPolicies;
struct ClientOptions
{
/**
* @brief Define policies to be called one time for every Http request from an sdk client.
*
*/
std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> PerOperationPolicies;
/**
* @brief Define policies to be called each time and sdk client tries to send the Http request.
*
*/
std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> PerRetryPolicies;
public:
/**
* @brief Move each policy from \p options into the new instance.
*
*/
explicit ClientOptions(ClientOptions&& options)
: m_perOperationPolicies(std::move(options.m_perOperationPolicies)),
m_perRetryPolicies(std::move(options.m_perRetryPolicies))
: PerOperationPolicies(std::move(options.PerOperationPolicies)),
PerRetryPolicies(std::move(options.PerRetryPolicies))
{
}
@ -44,15 +53,15 @@ namespace Azure { namespace Core { namespace Internal {
*/
explicit ClientOptions(ClientOptions const& options)
{
m_perOperationPolicies.reserve(options.m_perOperationPolicies.size());
for (auto& policy : options.m_perOperationPolicies)
PerOperationPolicies.reserve(options.PerOperationPolicies.size());
for (auto& policy : options.PerOperationPolicies)
{
m_perOperationPolicies.emplace_back(policy->Clone());
PerOperationPolicies.emplace_back(policy->Clone());
}
m_perRetryPolicies.reserve(options.m_perRetryPolicies.size());
for (auto& policy : options.m_perRetryPolicies)
PerRetryPolicies.reserve(options.PerRetryPolicies.size());
for (auto& policy : options.PerRetryPolicies)
{
m_perRetryPolicies.emplace_back(policy->Clone());
PerRetryPolicies.emplace_back(policy->Clone());
}
}
@ -72,52 +81,6 @@ namespace Azure { namespace Core { namespace Internal {
* @brief Telemetry options.
*/
Azure::Core::Http::TelemetryOptions Telemetry;
/**
* @brief Adds a policy into the client.
*
* @remark The order of policy while sending the request is controlled by \p order.
* If you want the policy to execute once per client request use #HttpPolicyOrder::PerCall,
* otherwise use #HttpPolicyOrder::PerRetry to run the policy for every retry.
*
* @param policy The policy instance to be added to the pipeline.
* @param order The order to execute the policy.
*/
void AddPolicy(
std::unique_ptr<Azure::Core::Http::HttpPolicy> policy,
Azure::Core::Http::HttpPolicyOrder order)
{
switch (order)
{
case Azure::Core::Http::HttpPolicyOrder::PerCall:
m_perOperationPolicies.push_back(std::move(policy));
break;
case Azure::Core::Http::HttpPolicyOrder::PerRetry:
m_perRetryPolicies.push_back(std::move(policy));
break;
default:
throw std::invalid_argument("Invalid order parameter");
}
}
/**
* @brief Get the Per Call Policies.
*
*/
std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> const& GetPerCallPolicies() const
{
return m_perOperationPolicies;
}
/**
* @brief Get the Per Retry Policies.
*
*/
std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> const& GerPerRetryPolicies() const
{
return m_perRetryPolicies;
}
};
}}} // namespace Azure::Core::Internal

4
sdk/core/azure-core/inc/azure/core/internal/http/pipeline.hpp
View File

@ -76,8 +76,8 @@ namespace Azure { namespace Core { namespace Internal { namespace Http {
std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>>&& perRetryPolicies,
std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>>&& perCallPolicies)
{
auto const& perCallClientPolicies = clientOptions.GetPerCallPolicies();
auto const& perRetryClientPolicies = clientOptions.GerPerRetryPolicies();
auto const& perCallClientPolicies = clientOptions.PerOperationPolicies;
auto const& perRetryClientPolicies = clientOptions.PerRetryPolicies;
// Adding 5 for:
// - TelemetryPolicy
// - RequestIdPolicy