kcenon::common::resilience::circuit_breaker::guard Class Reference

RAII guard for automatic success/failure recording. More...

#include <circuit_breaker.h>

Collaboration diagram for kcenon::common::resilience::circuit_breaker::guard:

Public Member Functions
	guard (circuit_breaker &breaker)
	~guard ()
	guard (const guard &)=delete
guard &	operator= (const guard &)=delete
	guard (guard &&)=delete
guard &	operator= (guard &&)=delete
auto	record_success () -> void
	Explicitly mark operation as successful. Prevents automatic failure recording on destruction.

Private Attributes
circuit_breaker &	breaker_
bool	committed_

Detailed Description

RAII guard for automatic success/failure recording.

Automatically records failure if destroyed without explicit success call. Helps prevent forgetting to record operation results.

Definition at line 176 of file circuit_breaker.h.

Constructor & Destructor Documentation

guard() [1/3]

kcenon::common::resilience::circuit_breaker::guard::guard ( circuit_breaker & breaker )

inlineexplicit

Definition at line 178 of file circuit_breaker.h.

            : breaker_(breaker)
            , committed_(false)
        {
        }

~guard()

kcenon::common::resilience::circuit_breaker::guard::~guard ( )

inline

Definition at line 184 of file circuit_breaker.h.

        {
            if (!committed_) {
                breaker_.record_failure();
            }
        }

References breaker_, committed_, and kcenon::common::resilience::circuit_breaker::record_failure().

Here is the call graph for this function:

guard() [2/3]

kcenon::common::resilience::circuit_breaker::guard::guard ( const guard & )

delete

guard() [3/3]

kcenon::common::resilience::circuit_breaker::guard::guard ( guard && )

delete

Member Function Documentation

operator=() [1/2]

guard & kcenon::common::resilience::circuit_breaker::guard::operator= ( const guard & )

delete

operator=() [2/2]

guard & kcenon::common::resilience::circuit_breaker::guard::operator= ( guard && )

delete

record_success()

auto kcenon::common::resilience::circuit_breaker::guard::record_success ( ) -> void

inline

Explicitly mark operation as successful. Prevents automatic failure recording on destruction.

Definition at line 201 of file circuit_breaker.h.

        {
            committed_ = true;
            breaker_.record_success();
        }

References breaker_, committed_, and kcenon::common::resilience::circuit_breaker::record_success().

Here is the call graph for this function:

Member Data Documentation

breaker_

circuit_breaker& kcenon::common::resilience::circuit_breaker::guard::breaker_

private

Definition at line 208 of file circuit_breaker.h.

Referenced by record_success(), and ~guard().

committed_

bool kcenon::common::resilience::circuit_breaker::guard::committed_

private

Definition at line 209 of file circuit_breaker.h.

Referenced by record_success(), and ~guard().

---

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

• include/kcenon/common/resilience/circuit_breaker.h