Microsoft Azure Storage Client Library for C++  7.5.0
The Microsoft Azure Storage Client Library for C++ is a library for working with the Azure Storage Services in C++.
Public Member Functions | List of all members
azure::storage::retry_info Class Reference

Specifies parameters for the next retry of a request to be made against the Windows Azure storage services, including the target location and location mode for the next retry and the interval until the next retry. More...

Public Member Functions

 retry_info ()
 Initializes a new instance of the azure::storage::retry_info class. More...
 
 retry_info (const retry_context &context)
 Initializes a new instance of the azure::storage::retry_info class. More...
 
bool should_retry () const
 Indicates that the request should be retried. More...
 
storage_location target_location () const
 Gets the target location for the next retry. More...
 
void set_target_location (storage_location value)
 Sets the target location for the next retry. More...
 
location_mode updated_location_mode () const
 Gets the location mode for subsequent retries. More...
 
void set_updated_location_mode (location_mode value)
 Sets the location mode for subsequent retries. More...
 
std::chrono::milliseconds retry_interval () const
 Gets the interval until the next retry. More...
 
void set_retry_interval (std::chrono::milliseconds value)
 Sets the interval until the next retry. More...
 

Detailed Description

Specifies parameters for the next retry of a request to be made against the Windows Azure storage services, including the target location and location mode for the next retry and the interval until the next retry.

Constructor & Destructor Documentation

◆ retry_info() [1/2]

azure::storage::retry_info::retry_info ( )
inline

Initializes a new instance of the azure::storage::retry_info class.

◆ retry_info() [2/2]

azure::storage::retry_info::retry_info ( const retry_context context)
inlineexplicit

Initializes a new instance of the azure::storage::retry_info class.

Parameters
contextThe azure::storage::retry_context object that was passed in to the retry policy.

Member Function Documentation

◆ retry_interval()

std::chrono::milliseconds azure::storage::retry_info::retry_interval ( ) const
inline

Gets the interval until the next retry.

Returns
The interval until the next retry.

◆ set_retry_interval()

void azure::storage::retry_info::set_retry_interval ( std::chrono::milliseconds  value)
inline

Sets the interval until the next retry.

Parameters
valueThe interval until the next retry.

◆ set_target_location()

void azure::storage::retry_info::set_target_location ( storage_location  value)
inline

Sets the target location for the next retry.

Parameters
valueThe target location for the next retry.

◆ set_updated_location_mode()

void azure::storage::retry_info::set_updated_location_mode ( location_mode  value)
inline

Sets the location mode for subsequent retries.

Parameters
valueThe location mode for subsequent retries.

◆ should_retry()

bool azure::storage::retry_info::should_retry ( ) const
inline

Indicates that the request should be retried.

Returns
true if the request should be retried.

◆ target_location()

storage_location azure::storage::retry_info::target_location ( ) const
inline

Gets the target location for the next retry.

Returns
The target location for the next retry.

◆ updated_location_mode()

location_mode azure::storage::retry_info::updated_location_mode ( ) const
inline

Gets the location mode for subsequent retries.

Returns
The location mode for subsequent retries.