Retry executor template class. More...

#include <retry_policy.h>

Collaboration diagram for kcenon::monitoring::retry_executor< T >:

Public Types
using	config = retry_config

Public Member Functions
	retry_executor ()

	retry_executor (const std::string &name)

	retry_executor (const std::string &name, const config &cfg)

template<typename Func >
common::Result< T >	execute (Func &&func)
	Execute a function with retry logic.

retry_metrics	get_metrics () const
	Get retry metrics.

void	reset_metrics ()
	Reset metrics.

const std::string &	get_name () const
	Get executor name.

Private Member Functions
std::chrono::milliseconds	calculate_delay (size_t attempt) const
	Calculate delay for the current attempt.

Static Private Member Functions
static size_t	fibonacci (size_t n)
	Calculate Fibonacci number.

Private Attributes
std::string	name_

config	config_

retry_metrics	metrics_

Detailed Description

template<typename T>
class kcenon::monitoring::retry_executor< T >

Retry executor template class.

Executes operations with configurable retry logic.

Template Parameters

T	The return value type of operations

Examples: graceful_degradation_example.cpp.

Definition at line 134 of file retry_policy.h.

Member Typedef Documentation

◆ config

template<typename T >

using kcenon::monitoring::retry_executor< T >::config = retry_config

Definition at line 136 of file retry_policy.h.

Constructor & Destructor Documentation

◆ retry_executor() [1/3]

template<typename T >

kcenon::monitoring::retry_executor< T >::retry_executor ( )

inline

Definition at line 138 of file retry_policy.h.

138: name_("default"), config_() {}

kcenon::monitoring::retry_executor::name_

std::string name_

Definition retry_policy.h:265

kcenon::monitoring::retry_executor::config_

config config_

Definition retry_policy.h:266

◆ retry_executor() [2/3]

template<typename T >

kcenon::monitoring::retry_executor< T >::retry_executor ( const std::string & name )

inlineexplicit

Definition at line 140 of file retry_policy.h.

141 : name_(name), config_() {}

◆ retry_executor() [3/3]

template<typename T >

kcenon::monitoring::retry_executor< T >::retry_executor	(	const std::string &	name,
		const config &	cfg )

inlineexplicit

Definition at line 143 of file retry_policy.h.

144 : name_(name), config_(cfg) {}

Member Function Documentation

◆ calculate_delay()

template<typename T >

std::chrono::milliseconds kcenon::monitoring::retry_executor< T >::calculate_delay ( size_t attempt ) const

inlineprivate

Calculate delay for the current attempt.

Parameters

attempt Current attempt number (0-indexed)

Returns: Delay duration

Definition at line 213 of file retry_policy.h.

                                                                {
        std::chrono::milliseconds delay;
 
        switch (config_.strategy) {
            case retry_strategy::fixed_delay:
                delay = config_.initial_delay;
                break;
 
            case retry_strategy::exponential_backoff: {
                auto multiplier = std::pow(config_.backoff_multiplier, static_cast<double>(attempt - 1));
                auto delay_ms = static_cast<long long>(config_.initial_delay.count() * multiplier);
                delay = std::chrono::milliseconds(delay_ms);
                break;
            }
 
            case retry_strategy::linear_backoff:
                delay = config_.initial_delay * attempt;
                break;
 
            case retry_strategy::fibonacci_backoff: {
                delay = config_.initial_delay * fibonacci(attempt);
                break;
            }
 
            default:
                delay = config_.initial_delay;
                break;
        }
 
        return std::min(delay, config_.max_delay);
    }

References kcenon::monitoring::retry_config::backoff_multiplier, kcenon::monitoring::retry_executor< T >::config_, kcenon::monitoring::delay, kcenon::monitoring::exponential_backoff, kcenon::monitoring::retry_executor< T >::fibonacci(), kcenon::monitoring::fibonacci_backoff, kcenon::monitoring::fixed_delay, kcenon::monitoring::retry_config::initial_delay, kcenon::monitoring::linear_backoff, kcenon::monitoring::retry_config::max_delay, and kcenon::monitoring::retry_config::strategy.

Referenced by kcenon::monitoring::retry_executor< T >::execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

template<typename T >

template<typename Func >

common::Result< T > kcenon::monitoring::retry_executor< T >::execute ( Func && func )

inline

Execute a function with retry logic.

Template Parameters

Func	The function type to execute (must return common::Result<T>)

Parameters

func	The function to execute

Returns: common::Result<T> containing success value or error from last attempt

Definition at line 154 of file retry_policy.h.

                                         {
        metrics_.total_executions++;
 
        common::Result<T> last_result = common::Result<T>::err(error_info(monitoring_error_code::operation_failed, "No attempts made").to_common_error());
 
        for (size_t attempt = 0; attempt < config_.max_attempts; ++attempt) {
            if (attempt > 0) {
                metrics_.total_retries++;
                auto delay = calculate_delay(attempt);
                std::this_thread::sleep_for(delay);
            }
 
            last_result = func();
 
            if (last_result.is_ok()) {
                metrics_.successful_executions++;
                return last_result;
            }
 
            if (config_.should_retry) {
                auto err_info = error_info::from_common_error(last_result.error());
                if (!config_.should_retry(err_info)) {
                    metrics_.failed_executions++;
                    return last_result;
                }
            }
        }
 
        metrics_.failed_executions++;
        return last_result;
    }

Referenced by demonstrate_combined_patterns(), demonstrate_retry_policy(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fibonacci()

template<typename T >

static size_t kcenon::monitoring::retry_executor< T >::fibonacci ( size_t n )

inlinestaticprivate

Calculate Fibonacci number.

Parameters

n	Index in Fibonacci sequence

Returns: Fibonacci number at index n

Definition at line 250 of file retry_policy.h.

                                      {
        if (n <= 1) return 1;
 
        size_t prev = 1;
        size_t curr = 1;
 
        for (size_t i = 2; i <= n; ++i) {
            size_t next = prev + curr;
            prev = curr;
            curr = next;
        }
 
        return curr;
    }

Referenced by kcenon::monitoring::retry_executor< T >::calculate_delay().

Here is the caller graph for this function:

◆ get_metrics()

template<typename T >

retry_metrics kcenon::monitoring::retry_executor< T >::get_metrics ( ) const

inline

Get retry metrics.

Definition at line 189 of file retry_policy.h.

                                      {
        return metrics_;
    }

References kcenon::monitoring::retry_executor< T >::metrics_.

Referenced by demonstrate_combined_patterns(), demonstrate_retry_policy(), TEST_F(), TEST_F(), and TEST_F().

Here is the caller graph for this function:

◆ get_name()

template<typename T >

const std::string & kcenon::monitoring::retry_executor< T >::get_name ( ) const

inline

Get executor name.

Definition at line 203 of file retry_policy.h.

                                      {
        return name_;
    }

References kcenon::monitoring::retry_executor< T >::name_.

◆ reset_metrics()

template<typename T >

void kcenon::monitoring::retry_executor< T >::reset_metrics ( )

inline

Reset metrics.

Definition at line 196 of file retry_policy.h.

                         {
        metrics_.reset();
    }

References kcenon::monitoring::retry_executor< T >::metrics_, and kcenon::monitoring::retry_metrics::reset().

Referenced by TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ config_

template<typename T >

config kcenon::monitoring::retry_executor< T >::config_

private

Definition at line 266 of file retry_policy.h.

Referenced by kcenon::monitoring::retry_executor< T >::calculate_delay(), and kcenon::monitoring::retry_executor< T >::execute().

◆ metrics_

template<typename T >

retry_metrics kcenon::monitoring::retry_executor< T >::metrics_

mutableprivate

Definition at line 267 of file retry_policy.h.

Referenced by kcenon::monitoring::retry_executor< T >::execute(), kcenon::monitoring::retry_executor< T >::get_metrics(), and kcenon::monitoring::retry_executor< T >::reset_metrics().

◆ name_

template<typename T >

std::string kcenon::monitoring::retry_executor< T >::name_

private

Definition at line 265 of file retry_policy.h.

Referenced by kcenon::monitoring::retry_executor< T >::get_name().

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

include/kcenon/monitoring/reliability/retry_policy.h

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ config

Constructor & Destructor Documentation

◆ retry_executor() [1/3]

◆ retry_executor() [2/3]

◆ retry_executor() [3/3]

Member Function Documentation

◆ calculate_delay()

◆ execute()

◆ fibonacci()

◆ get_metrics()

◆ get_name()

◆ reset_metrics()

Member Data Documentation

◆ config_

◆ metrics_

◆ name_