thread_pool_interface.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include <chrono>
#include <cstddef>
#include <functional>
#include <future>
#include <string>
#include <thread>
#include <type_traits>
 
namespace kcenon::pacs::integration {
 
// ─────────────────────────────────────────────────────
// Shared Types
// ─────────────────────────────────────────────────────
 
enum class job_priority {
    critical = 0,  
    high = 1,      
    normal = 2,    
    low = 3        
};
 
struct thread_pool_config {
    std::size_t min_threads = 2;
 
    std::size_t max_threads = std::thread::hardware_concurrency();
 
    std::chrono::milliseconds idle_timeout{30000};
 
    bool use_lock_free_queue = true;
 
    std::string pool_name = "pacs_thread_pool";
};
 
class thread_pool_interface {
public:
    virtual ~thread_pool_interface() = default;
 
    // =========================================================================
    // Lifecycle Management
    // =========================================================================
 
    [[nodiscard]] virtual auto start() -> bool = 0;
 
    [[nodiscard]] virtual auto is_running() const noexcept -> bool = 0;
 
    virtual void shutdown(bool wait_for_completion = true) = 0;
 
    // =========================================================================
    // Task Submission
    // =========================================================================
 
    [[nodiscard]] virtual auto submit(std::function<void()> task)
        -> std::future<void> = 0;
 
    [[nodiscard]] virtual auto submit_with_priority(
        job_priority priority,
        std::function<void()> task) -> std::future<void> = 0;
 
    virtual void submit_fire_and_forget(std::function<void()> task) = 0;
 
    // =========================================================================
    // Statistics
    // =========================================================================
 
    [[nodiscard]] virtual auto get_thread_count() const -> std::size_t = 0;
 
    [[nodiscard]] virtual auto get_pending_task_count() const -> std::size_t = 0;
 
    [[nodiscard]] virtual auto get_idle_worker_count() const -> std::size_t = 0;
 
protected:
    thread_pool_interface() = default;
 
    thread_pool_interface(const thread_pool_interface&) = delete;
    thread_pool_interface& operator=(const thread_pool_interface&) = delete;
 
    thread_pool_interface(thread_pool_interface&&) = default;
    thread_pool_interface& operator=(thread_pool_interface&&) = default;
};
 
}  // namespace kcenon::pacs::integration