Aws::Crt::S3::S3RetryStrategy Class Reference

#include <S3.h>

Public Member Functions
	S3RetryStrategy (const S3RetryStrategy &)=delete
S3RetryStrategy &	operator= (const S3RetryStrategy &)=delete
	S3RetryStrategy (S3RetryStrategy &&other) noexcept=default
S3RetryStrategy &	operator= (S3RetryStrategy &&other) noexcept=default
	~S3RetryStrategy () noexcept=default
	operator bool () const noexcept

Static Public Member Functions
static S3RetryStrategy	CreateStandard () noexcept
static S3RetryStrategy	CreateExponentialBackoff (Io::EventLoopGroup &elGroup, const S3RetryStrategyExponentialBackoffOptions &options={}) noexcept
static S3RetryStrategy	CreateNoRetry () noexcept

Detailed Description

C++ binding over a CRT aws_retry_strategy handle. Owns the handle and releases it on destruction; construct one with the static Create* factories. Hand the result to S3ClientConfig::SetRetryStrategy or return it from a SetRetryStrategyFactory callback - the S3 client acquires its own reference at construction, so the binding may be destroyed afterward.

Move-only: the underlying handle has single-owner semantics here.

Constructor & Destructor Documentation

S3RetryStrategy() [1/2]

Aws::Crt::S3::S3RetryStrategy::S3RetryStrategy ( const S3RetryStrategy &  )

delete

S3RetryStrategy() [2/2]

Aws::Crt::S3::S3RetryStrategy::S3RetryStrategy ( S3RetryStrategy &&  other )

defaultnoexcept

~S3RetryStrategy()

Aws::Crt::S3::S3RetryStrategy::~S3RetryStrategy ( )

defaultnoexcept

Member Function Documentation

CreateExponentialBackoff()

S3RetryStrategy Aws::Crt::S3::S3RetryStrategy::CreateExponentialBackoff ( Io::EventLoopGroup &  elGroup, const S3RetryStrategyExponentialBackoffOptions &  options = {}  )

staticnoexcept

Build an exponential-backoff retry strategy. Requires an event loop group to schedule the backoff timers on.

Parameters

elGroup	event loop group used to schedule retries.
options	backoff tuning knobs.

Returns

a binding owning the new strategy, or an empty binding on failure.

CreateNoRetry()

S3RetryStrategy Aws::Crt::S3::S3RetryStrategy::CreateNoRetry ( )

staticnoexcept

Build a strategy that disables retries.

Returns

a binding owning the new strategy, or an empty binding on failure.

CreateStandard()

S3RetryStrategy Aws::Crt::S3::S3RetryStrategy::CreateStandard ( )

staticnoexcept

Build a token-bucket standard retry strategy.

Returns

a binding owning the new strategy, or an empty binding on failure.

operator bool()

Aws::Crt::S3::S3RetryStrategy::operator bool ( ) const

inlineexplicitnoexcept

Returns

true if this binding owns a valid strategy handle.

operator=() [1/2]

S3RetryStrategy & Aws::Crt::S3::S3RetryStrategy::operator= ( const S3RetryStrategy &  )

delete

operator=() [2/2]

S3RetryStrategy & Aws::Crt::S3::S3RetryStrategy::operator= ( S3RetryStrategy &&  other )

defaultnoexcept

---

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

• include/aws/crt/s3/S3.h
• source/s3/S3.cpp