circuit_breaker_policy.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2024, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "pool_policy.h"
#include <kcenon/common/resilience/circuit_breaker.h>
#include <kcenon/common/resilience/circuit_breaker_config.h>
#include <kcenon/common/resilience/circuit_state.h>
 
#include <atomic>
#include <memory>
#include <string>
 
namespace kcenon::thread
{
    // Import resilience types from common_system
    using common::resilience::circuit_breaker;
    using common::resilience::circuit_breaker_config;
    using common::resilience::circuit_state;
 
    class circuit_breaker_policy : public pool_policy
    {
    public:
        explicit circuit_breaker_policy(const circuit_breaker_config& config = {});
 
        explicit circuit_breaker_policy(std::shared_ptr<circuit_breaker> cb);
 
        ~circuit_breaker_policy() override = default;
 
        // Non-copyable
        circuit_breaker_policy(const circuit_breaker_policy&) = delete;
        circuit_breaker_policy& operator=(const circuit_breaker_policy&) = delete;
 
        // Non-movable (std::atomic is not movable)
        circuit_breaker_policy(circuit_breaker_policy&&) = delete;
        circuit_breaker_policy& operator=(circuit_breaker_policy&&) = delete;
 
        // ============================================
        // pool_policy Interface
        // ============================================
 
        auto on_enqueue(job& j) -> common::VoidResult override;
 
        void on_job_start(job& j) override;
 
        void on_job_complete(job& j, bool success, const std::exception* error = nullptr) override;
 
        [[nodiscard]] auto get_name() const -> std::string override;
 
        [[nodiscard]] auto is_enabled() const -> bool override;
 
        void set_enabled(bool enabled) override;
 
        // ============================================
        // Circuit Breaker Specific Methods
        // ============================================
 
        [[nodiscard]] auto is_accepting_work() const -> bool;
 
        [[nodiscard]] auto get_state() const -> circuit_state;
 
        [[nodiscard]] auto get_circuit_breaker() const -> std::shared_ptr<circuit_breaker>;
 
    private:
        std::shared_ptr<circuit_breaker> circuit_breaker_;
        std::atomic<bool> enabled_{true};
    };
 
} // namespace kcenon::thread