Aws::Client::RetryStrategy Class Reference

#include <RetryStrategy.h>

Inheritance diagram for Aws::Client::RetryStrategy:

Public Member Functions

virtual ~RetryStrategy ()=default

 

virtual bool ShouldRetry (const AWSError< CoreErrors > &error, long attemptedRetries) const =0

 

virtual long CalculateDelayBeforeNextRetry (const AWSError< CoreErrors > &error, long attemptedRetries) const =0

 

virtual long GetMaxAttempts () const

 

virtual void GetSendToken ()

 

virtual bool HasSendToken ()

 

virtual void RequestBookkeeping (const HttpResponseOutcome &)

 

virtual void RequestBookkeeping (const HttpResponseOutcome &, const AWSError< CoreErrors > &)

 

virtual const char * GetStrategyName () const

 

Detailed Description

Interface for defining a Retry Strategy. Override this class to provide your own custom retry behavior.

Definition at line 38 of file RetryStrategy.h.

Constructor & Destructor Documentation

~RetryStrategy()

virtual Aws::Client::RetryStrategy::~RetryStrategy ( )

virtualdefault

Member Function Documentation

CalculateDelayBeforeNextRetry()

virtual long Aws::Client::RetryStrategy::CalculateDelayBeforeNextRetry ( const AWSError< CoreErrors > &  error,

long  attemptedRetries 

) const

pure virtual

Calculates the time in milliseconds the client should sleep before attempting another request based on the error and attemptedRetries count.

Implemented in Aws::Client::DefaultRetryStrategy, and Aws::Client::StandardRetryStrategy.

GetMaxAttempts()

virtual long Aws::Client::RetryStrategy::GetMaxAttempts ( ) const

inlinevirtual

Gets max number of attempts allowed for an operation. Returns non positive value if not defined.

Reimplemented in Aws::Client::DefaultRetryStrategy, and Aws::Client::StandardRetryStrategy.

Definition at line 56 of file RetryStrategy.h.

GetSendToken()

virtual void Aws::Client::RetryStrategy::GetSendToken ( )

inlinevirtual

Retrieves send tokens from the bucket. Throws an exception if not available.

Definition at line 61 of file RetryStrategy.h.

GetStrategyName()

virtual const char * Aws::Client::RetryStrategy::GetStrategyName ( ) const

inlinevirtual

Get return strategy name.

Reimplemented in Aws::Client::AdaptiveRetryStrategy, Aws::Client::DefaultRetryStrategy, and Aws::Client::StandardRetryStrategy.

Definition at line 81 of file RetryStrategy.h.

HasSendToken()

virtual bool Aws::Client::RetryStrategy::HasSendToken ( )

inlinevirtual

Retrieves send tokens from the bucket. Returns true is send token is retrieved.

Reimplemented in Aws::Client::AdaptiveRetryStrategy.

Definition at line 66 of file RetryStrategy.h.

RequestBookkeeping() [1/2]

virtual void Aws::Client::RetryStrategy::RequestBookkeeping ( const HttpResponseOutcome &  )

inlinevirtual

Update status, like the information of retry quota when receiving a response.

Reimplemented in Aws::Client::AdaptiveRetryStrategy, and Aws::Client::StandardRetryStrategy.

Definition at line 75 of file RetryStrategy.h.

RequestBookkeeping() [2/2]

virtual void Aws::Client::RetryStrategy::RequestBookkeeping ( const HttpResponseOutcome &  ,

const AWSError< CoreErrors > &   

)

inlinevirtual

Reimplemented in Aws::Client::AdaptiveRetryStrategy, and Aws::Client::StandardRetryStrategy.

Definition at line 76 of file RetryStrategy.h.

ShouldRetry()

virtual bool Aws::Client::RetryStrategy::ShouldRetry ( const AWSError< CoreErrors > &  error,

long  attemptedRetries 

) const

pure virtual

Returns true if the error can be retried given the error and the number of times already tried.

Implemented in Aws::Client::DefaultRetryStrategy, Aws::Client::StandardRetryStrategy, and Aws::Client::SpecifiedRetryableErrorsRetryStrategy.

---

The documentation for this class was generated from the following file:

• src/aws-cpp-sdk-core/include/aws/core/client/RetryStrategy.h